|Oracle® Fusion Applications Extensibility Guide
11g Release 5 (11.1.5)
Part Number E16691-07
|PDF · Mobi · ePub|
This appendix describes common problems that you might encounter when extending and customizing Oracle Fusion Applications and explains how to solve them. It contains the following topics:
In addition to this appendix, review Oracle Fusion Middleware Error Messages Reference for information about the error messages you may encounter.
Use the following guidelines and process within this appendix to help focus and minimize the time you spend resolving problems.
When using the information in this appendix, consider the following guidelines:
After performing any of the solution procedures in this appendix, immediately retry the failed task that led you to this troubleshooting information. If the task still fails when you retry it, perform a different solution procedure in this appendix and then try the failed task again. Repeat this process until you resolve the problem.
Make notes about the solution procedures you perform, symptoms you see, and data you collect while troubleshooting. If you cannot resolve the problem using the information in this appendix and you must log a service request, the notes will expedite the process of solving the problem.
Follow the process outlined in Table A-1 when using the information in this appendix. If the information in a particular section does not resolve your problem, proceed to the next step in this process.
Table A-1 Process for Using the Information in this Appendix
|Step||Section to Use||Purpose|
Get started troubleshooting customizations. The procedures in this section quickly address a wide variety of problems.
Perform problem-specific troubleshooting procedures for customizations. This section describes:
Use My Oracle Support to get additional troubleshooting information about Oracle Fusion Applications or Oracle Business Intelligence. My Oracle Support provides access to several useful troubleshooting resources, including Knowledge Base articles and Community Forums and Discussions.
Log a service request if the information in this appendix and My Oracle Support does not resolve your problem. You can log a service request using My Oracle Support at
This section provides the following general approaches for managing and diagnosing customization issues:
The Manage Customizations dialog displays the customizations of the task flows in a page. You can access the Manage Customizations dialog from Page Composer and from the Administration menu in the global area of Oracle Fusion Applications. You can also use this dialog to delete page customizations, and to upload and download page customization files. For more information, see Section 2.3, "Viewing and Diagnosing Runtime Customizations."
Customizations are stored in XML files. You can export the customizations in one of two ways:
Use the Manage Customizations dialog to export user interface personalizations or page customizations. Choose the desired level and download the document.
For more information, see Section 2.4.1, "Downloading and Uploading Customization Files Using the Manage Customizations Dialog."
Use an Oracle WebLogic Scripting Tool (WLST) command as shown in Example A-1.
Example A-1 WLST Command to Export Customization Document
exportMetadata (application='application name', server='server name', docs= '/oracle/apps/hcm/dashboard/hrSpecialist/publicUi/page/mdssys/Site/SITE/VisaWorkPermitExpirationRegion.jsff.xml', toLocation='temp location');
For more information about using
exportMetadata, see Section 2.4.2, "Downloading and Uploading Customization Files Using WLST Commands" and the "Application Metadata Management Commands" section of Oracle Fusion Middleware WebLogic Scripting Tool Command Reference.
For information about obtaining the string to use for the
docs argument, see Section A.2.6, "Determining the Full Path for a Customizations Document."
If you are not sure of the document name, append
'/*' to the path in the
docs argument to include all customization documents in the directory. Append
'/**' to the path in the
docs argument to also include the customization documents in the subdirectories. For example, use
'/oracle/apps/hcm/dashboard/hrSpecialist/publicUi/**' to import or export all documents under the
publicUi directory and its subdirectories.
You can also use Oracle Enterprise Manager Fusion Applications Control to export an application's customization files. For more information, see the "Transferring Metadata Using Fusion Middleware Control" section of the Oracle Fusion Middleware Administrator's Guide. The referenced procedure describes using Fusion Middleware Control, but also applies to Fusion Applications Control.
You can use the Manage Customizations dialog to delete customizations. In the Name list, find the page that contains the customizations and click Delete for the customization document that you want to delete.
If the customizations were made by someone other than the logged-in user, and you have administrator privileges, you can display that person's customizations by selecting Select User from the Layer Name dropdown list.
For more information about the Manage Customizations dialog, see Section 2.3, "Viewing and Diagnosing Runtime Customizations."
You can also use Oracle WebLogic Scripting Tool (WLST) commands to delete customizations, as shown in Example A-2.
Example A-2 WLST Command to Delete a Customization Document
deleteMetadata (application='application name', server='server name', docs= '/oracle/apps/hcm/dashboard/hrSpecialist/publicUi/page/mdssys/Site/SITE/VisaWorkPermitExpirationRegion.jsff.xml');
For more information about the
deleteMetadata command, see the "Application Metadata Management Commands" section of Oracle Fusion Middleware WebLogic Scripting Tool Command Reference.
Alternatively, you can use Fusion Applications Control to delete an application's metadata. For more information, see the "Managing the Metadata Repository" chapter in the Oracle Fusion Middleware Administrator's Guide.
Before you make customizations, you can create a backup of a known good state by creating a label. If an issue occurs after creating the label, you can revert back to that label by promoting it to the tip. For more information, see the "Creating Metadata Labels" and "Promoting Metadata Labels" sections of the Oracle Fusion Middleware Administrator's Guide.
Another way to back up and restore customizations is by exporting and importing customization files, as described in Section A.2.2, "Importing and Exporting Customizations."
When you make customizations, be careful to choose the correct layer.
Use the site layer for customizations that affect all end users.
Use the global layer for ADF Business Components customizations.
Use product-specific layers appropriately as documented.
The following string shows the structure of the full document path for a customization document:
For example, the full document path for the Visa Work Permit Expiration region is
You can obtain the full document path of a customized region on a page by completing the following steps:
Go to the page that contains the customized region and choose Customize page_name Pages from the Administration menu in the global area of Oracle Fusion Applications to open Page Composer.
If you have more than one layer available for customization, the Layer Picker dialog is displayed. In the Edit column, select the desired layer.
Choose Source from the View menu.
In the hierarchical list, drill down to and hover over the customized region to display the full document path of the JSF fragment that contains the customization, such as
/oracle/apps/hcm/dashboard/hrSpecialist/publicUI/page/mdssys/Site/SITE/VisaWorkPermitExpirationRegion.jsf.xml. Make a note of this path.
For descriptive flexfield configurations, you can use the Register Descriptive Flexfields task to find the name of the flexfield's package.
Customizations will not appear if the customization layer is not active in a product. To determine if a customization layer is active, open the
adf-config.xml file for the application and look for the
<cust-config> tag, as shown in Example A-3. The nested
<customization-class> tags show the active layers.
Example A-3 Active Customization Layers
<adf-mds-config xmlns="http://xmlns.oracle.com/adf/mds/config"> <mds-config xmlns="http://xmlns.oracle.com/mds/config" version="11.1.1.000"> <cust-config> <match path="/"> <customization-class name ="oracle.apps.fnd.applcore.customization.GlobalCC"/> <customization-class name ="oracle.apps.fnd.applcore.customization.SiteCC"/> <customization-class name ="oracle.apps.fnd.applcore.customization.UserCC"/> </match> </cust-config> </mds-config> </adf-mds-config>
To turn on runtime logging for customizations that are applied to a page, set the log level for the
oracle.mds.custmerge module to
FINEST. You can set the application's log level by choosing Troubleshooting from the Help menu. You might need to ask your administrator to give you privilege to set the log level.
If you have administration privileges, you can also use Fusion Applications Control to set the log level.
You can use logging, as described in Section A.2.8, "Logging Customizations that Are Applied to a Page," or you can use the Manage Customizations dialog, as described in Section A.2.1, "Diagnosing Customization Issues Using the Manage Customizations Dialog," to determine whether customizations have been applied to a page.
If you suspect that a problem might have been caused by a customization on a page, such as a user interface component disappearing from a page, you can export the page's customizations as described in Section A.2.2, "Importing and Exporting Customizations" and examine the document file.
You should perform your page customizations in sandboxes and publish only after full testing. You can use any number of sandboxes for testing, but you should use just one sandbox for publishing to prevent merge conflicts, as described in Section 2.2.1, "Sandboxes and Concurrent Usage." For information about analyzing merge conflicts, see Section A.3.2, "Conflict Errors Reported When You Publish a Sandbox."
When you deploy a flexfield, you have a choice of deploying to the full test environment or deploying to a sandbox. You should first deploy a flexfield to a sandbox so that you can test the configuration without affecting other end users. A flexfield that is successfully deployed to a sandbox will have a status of Deployed to Sandbox. After deploying to a sandbox, log out and log back in. The flexfield's sandbox will be active in your session for you to test. After testing, deploy to the full test environment so that the changes can be seen by other users. For more information, see Section 5.7, "Deploying Flexfield Configurations."
After you deploy a flexfield using the Manage Descriptive Flexfields task or the Manage Extensible Flexfields task, look at the value in the Deployment Status column to ensure that its status is Deployed (or Deployed to Sandbox if you are testing in a sandbox). If not, review the message in the Deployment Error Message column. For more information, see Section 5.7, "Deploying Flexfield Configurations."
If you successfully deployed a flexfield, but the custom attributes do not appear on the user interface page, ensure that you logged out and logged back in after deploying the flexfield. The changes do not appear until you log back in.
In the case of an extensible flexfield, if a context does not appear in the user interface, verify that the context is associated with one of the category's pages.
To examine a flexfield's configuration, export the deployed artifacts using the
exportMetadata WLST command as described in Section A.2.2, "Importing and Exporting Customizations."
When you deploy a flexfield from the Manage Descriptive Flexfields task or the Manage Extensible Flexfields task, the metadata is validated and, if errors are found, the flexfield is not deployed. If you want to check whether a flexfield will pass validation, choose Validate from the Actions menu.
The following are common problems and solutions:
The customizations that were made in the active sandbox are not appearing in the user interface.
Log out and log in again.
To ensure that the sandbox customization cache is cleared, log out and log back in before you enter a sandbox and after you perform any of the following sandbox-related actions:
Exit a sandbox
Publish a sandbox
Destroy a sandbox
You created customizations in a sandbox using the guidelines suggested in Section 2.2, "Using the Sandbox Manager." When you published the sandbox, merge conflicts were detected but not resolved.
Conflicts between sandboxes can arise when there is more than one sandbox that is intended for publishing in use. If two sandboxes contain customization changes to the same artifact and both are being published, the sandbox that is published last is given an option (by the sandbox manager) to overwrite the changes for that artifact from the sandbox that was published first. If the user working in the second sandbox decides to force-publish the second sandbox, the changes published by the first sandbox are overwritten. These types of conflicts can also occur with shared metadata files such as resource bundles that store translatable strings.
For more information, see Section 2.2.1, "Sandboxes and Concurrent Usage."
Before forcing the publishing of the sandbox, complete the following steps to analyze the conflicts:
Use the Manage Customizations dialog to download the customization document from the mainline code.
Make the sandbox active and use the Manage Customizations dialog to download the customization document from the sandbox.
Compare the two document files to analyze the conflicts.
When you publish a sandbox, you get a message that reports a conflict with
The security changes that you made in your sandbox conflict with other security changes in the mainline code. Abort the sandbox and recreate the changes in a new sandbox.
When you publish a sandbox, you get a message that reports a conflict with
Ignore the message, continue the process, and force the sandbox to be published.
After using Page Composer to change a dashboard page title, the old name is still displayed in the browser title bar, navigator link, or tab.
In addition to changing the page title property in the Task List Properties tab in Page Composer, which affects the browser title, you must also make the following changes:
Task lists menu entry, page heading, and tab title: Change the label in the Task List Task Properties tab as described in "Task: Customize a Page Title" in Section 3.2, "Editing a Page in Page Composer."
Navigator menu entry: Use the Manage Menu Customizations task to change the label for the menu item, as described in Chapter 6, "Customizing the Navigator Menu."
After making personalizations to a page, an end-user cannot open that page.
An administrator can use the Manage Customizations task to display and delete that user's personalizations for the page as described in Section A.2.3, "Deleting Customizations."
An expected menu item is not appearing in the Navigator menu.
Verify whether the menu item has been hidden from view as described in Section 6.4, "Hiding and Showing Nodes."
A custom menu item was added and the browser is not displaying the page indicated by the URL.
Open the Manage Menu Customizations task and verify that the web application name is the same as the context root for the application, and that the view ID is the
id attribute for the page's
<view> tag in the product's
public_html/WEB-INF/adfc-config.xml file. The URL should not contain the
For more information, see Section 6.3, "Adding Items."
When you choose an item in the Navigator menu, you get a "webApp value not defined" error message.
Verify that the application is in the topology tables, as described in the "Viewing the Routing Topology of an Oracle Fusion Applications Instance, Product Family, or Product" section in the Oracle Fusion Applications Administrator's Guide.
You are using JDeveloper in the Oracle Fusion Applications Administrator Customization role. The Customization Context table does not display the customization classes, as shown in Figure A-1, and the messages log displays an error message similar to the following text:
Error initializing MDS configuration for application "file:/somepath/TestCustomHR.jws". Customizations disabled for this application. MDS-00035: cannot load the class: oracle.apps.hcm.common.core.HcmCountryCC
Enable JDeveloper to see the customization classes that define the customization layers as described in Section 10.1.3, "Before You Begin Using JDeveloper to Customize."
After applying a customized skin that is based on the Oracle Fusion Applications Skin Extension (fusionFx-simple), the application does not show the expected customizations. For example, one or more of the following might occur:
The background is not in the expected color.
The user interface pages have a simple, minimal appearance instead of the expected skin.
Expected images do not appear.
Verify that you used the correct target application version when you created the custom skin. Try repackaging and redeploying the JAR file and ensure that no problems occur during the packaging process.
Ensure that you copied the necessary JAR files to all the Oracle Fusion applications and that you spelled the name of the skin correctly in the profile option.
For more information, see Section 19.3, "Applying a Custom Skin to Your Oracle Fusion Applications."
You click the Cancel button in the Set Preferences page and nothing changes.
The cancel action resets the page to the same values that appeared when you accessed the page. If you have not made any changes, the page appears exactly the same. To navigate away from the page, select Recent Items or Navigator from the global area of Oracle Fusion Applications or use the text box to search for a different page.
Use Oracle WebLogic Server Administration Console to locate a deployed application's enterprise archive (EAR) file.
To find the EAR file for a deployed application:
Make a note of the string that follows the host name in the URL of the deployed application. For example, if the URL is
http://myhost.mycompany.com:7401/myProd/faces/MyPage, make a note of
Open Oracle WebLogic Server Administration Console.
In the Overview tab, click the entry with a name similar to the text that you noted in Step 1, such as
MyProdApp (V2.0), to display the settings for that deployed application.
In the Overview tab, find the Path setting to see the path to the EAR file.
You can use My Oracle Support (formerly MetaLink) to help resolve Oracle Fusion Middleware problems. My Oracle Support contains several useful troubleshooting resources, such as:
Knowledge base articles
Community forums and discussions
Patches and upgrades
You can also use My Oracle Support to log a service request.
You can access My Oracle Support at