This chapter covers the following topics:
Oracle Application Management Pack for Oracle E-Business Suite includes a diagnostics feature which can be used to troubleshoot issues by running diagnostic tests. The tests are grouped into the modules listed below.
AMP: Cloning
Patch Manager
Customization Manager
User Monitoring
To navigate to the diagnostics module, on the Oracle E-Business Suite Management page, select Pack Diagnostics from the Administer menu.
To execute a diagnostic test, click Create. This will take you the page where you must provide the details to do the diagnosis. You must enter the details described in the following table:
| Field | Description |
|---|---|
| Name | A unique name to identify this instance of execution. This name can be later used to search for this instance of execution. |
| Module | You can select a specific module or all modules from the drop-down list. When you select a module, all tests for that module will be run. |
| Show Details | You can select the extent of detail you want in the final report.
|
| Category |
|
| Description | Optional description for this instance of the execution. |
You must add the Oracle E-Business Suite instance against which the diagnostic test will be executed. You can add multiple Oracle E-Business Suite instances. Click on the Add button in the Targets section. A list of values will pop up with the list of all the Oracle E-Business Suite instances discovered, and you can select the needed Oracle E-Business Suite instances. Once you are done with the selection, click the Submit button.
A job to run the tests is submitted, and the status column in the Requests table will show the status of the execution. You can refresh the page to get the latest status. You can click on the Status column to drill down further to see a detailed report of the execution. Expand the hierarchical table by clicking Expand All. There will be Tasks and Steps. Click on the status column of each step to get the detailed report for that step.
The pack diagnostics page by default list the name and other details of recent executions. You can search for any execution by its name.
You can rerun an instance of execution without entering the details again. Search for that instance. Select it and click on the Retest button.
You should run diagnostic tests on your system in preparation for the cloning procedures to ensure your system is set up properly. For more information on running diagnostic tests, see: How to Run a Diagnostic Test.
The following table lists generic diagnostic tests related to cloning.
| Step | Severity | Test | Description | Notes/Expected Results/Corrective Measures |
|---|---|---|---|---|
| EBS | Warning | Check if EBS has Shared File System | Check if the Oracle E-Business Suite is a multi-node applications tier with a shared file system configured. | Expected results: Yes/No. This is an informational message. If the shared file system is enabled and the result is No, please check 's_atname' to find out if all the nodes are consistent. Name of Command: CheckIfSFS |
| EBS | Critical | Check if AutoConfig is run on Database Tier | Verify if AutoConfig has been run on the database tier. | For cloning to work, it is mandatory that AutoConfig was successfully run on the source database tier. Name of Command: CheckIfAutoConfigIsRun |
| EBS | Critical | Check If AutoConfig Is Run on Applications Tier | Verify if AutoConfig has been run on the applications tier. | For Cloning to work, it is mandatory that AutoConfig was successfully run on the source applications tier. Name of Command: CheckIfAutoConfigIsRun |
| EBS | Warning | Get the Database Tier Operating System User Name | Get the O/S User Name for the database tier. | It is useful to know with which operating system user name the source database nodes have been created, as there could be file permissions issues in cloning. Corrective action: AutoConfig needs to be run in the Database Context to get t this value populated in the configuration. The configuration variable 's_dbuser' stores this information. Name of Command: GetDBOSUserInfo |
| EBS | Warning | Get Agent Perl Version | Verify Agent Perl utility version. | Cloning using the management pack requires the agent Perl utilities to be at a certain version level for certain cloning flows to function properly. Please make sure that the Perl version inside the Agent is compatible with that in the Oracle E-Business Suite instance (see the related diagnostic test for the Oracle E-Business Suite Perl Version) Name of Command: GetAgentPerlVersion |
| EBS | Warning | Get key environment variables for Database Context | Obtain key environment variables for Database Context, including:
PATH LD_LIBRARY_PATH LIBPATH SHLIB_PATH ORACLE_HOME ORACLE_SID PERL5LIB TNS_ADMIN |
Certain database context variables of the source Oracle E-Business Suite instance need to be definitively set with non-null values for the cloning job to proceed successfully. If this diagnostic test fails, run AutoConfig on the database tier so that the correct environment file is generated again. The values in the environment file are used in this command. Name of Command: GetEnvironmentVariableValues |
| EBS | Warning | Get the APPS tier Operating System User Name | Get the O/S User Name for the applications tier. | If this diagnostic test fails, rerun AutoConfig on the applications tier. AutoConfig should populate the 's_appsuser' variable in the applications tier context file correctly. Name of Command: GetAppsOSUserInfo |
| EBS | Warning | Get key information required for Apps Context Configvariables | Obtain key environment variables for the applications context, including:
s_base s_dbuser s_dbgroup s_appsuser s_appsgroup s_dbport s_port_pool s_config_home s_atName s_hostname |
Certain applications context variables of the source Oracle E-Business Suite instance need to be definitively set with non-null values for the clone job to proceed successfully. If this diagnostic test fails, run AutoConfig on the applications tier so that the correct environment file is generated again. The values in the environment file are used in this command. Name of Command: GetAPPSConfigVariables |
| EBS | Critical | CheckIOPatches for <Oracle E-Business Suite Release Name> | Verify that certain patches have been applied on the Oracle E-Business Suite target. | Certain I/O patches need to be definitively run on the Oracle E-Business Suite instance for some of the clone flows to work successfully. Note that this step may change – depending on the Oracle E-Business Suite release (for example, 12.0 and so on). The list of patches is contained in an XML file that might be modified to include or exclude recommended patches. Name of Command: CheckEBSPatches |
| EBS | Critical | Get EBS Perl Version | Check Oracle E-Business Suite Perl utility version. | Cloning using the management pack requires Oracle E-Business Suite Perl utilities to be at a certain version level for certain cloning flows to function properly. Please make sure that the Perl version on the Oracle E-Business Suite instance is compatible with that in the Agent (see related diagnostic test for the Agent Perl Version). Name of Command: CheckEBSPerlVersion |
| EBS | Critical | Check if AutoConfig is run on Applications Tier | Verify if AutoConfig has been run on the applications tier. | It is mandatory that AutoConfig completed successfully on the source applications tier for cloning to work. Name of Command: CheckIfAutoConfigIsRun |
| EBS | Warning | Get information for key Database Context Config variable | Obtain key database context variables that are required for non-“Smart Clone” cloning procedures, including:
s_base s_dbuser s_dbgroup s_appsuser s_appsgroup s_dbport s_port_pool s_hostname |
Certain database context variables of the source Oracle E-Business Suite instance need to be set with non-null values for the clone jobs to finish successfully. If this diagnostic test fails, rerun AutoConfig on the database tier. Name of Command: GetDBConfigVariables |
| EBS | Warning | Get key environment variables for Application Context | Obtain key environment variables for the applications context, including:
PATH LD_LIBRARY_PATH LIBPATH SHLIB_PATH ORACLE_HOME ORACLE_SID PERL5LIB TNS_ADMIN |
If this diagnostic test fails, rerun AutoConfig on the applications tier. Name of Command: GetEnvironmentVariableValues |
| EBS | Warning | Checks if Oracle E-Business Suite AD Snapshot is valid | Verify if the Oracle E-Business Suite AD snapshot is valid. | In order to perform a "scale-down clone" process (that is, a multi-node source applications tier instance which has non-shared APPL_TOPs to a unified APPL_TOP in the target), AMP needs to ensure that the snapshots for the source APPL_TOPs have been updated properly. Make sure the "Update Current View Snapshots" option in adadmin is run at least once after Oracle E-Business Suite creation.Name of Command: CheckIfADSnapshotIsValid |
| EBS | Summary | A summary of all of the diagnostic tests that have been executed, in the following groups: Successful, Failed, With Warning, Aborted, and Total. |
The following table lists user-specific diagnostic tests related to cloning.
| Step | Severity | Test | Description | Notes/Expected Results/Corrective Measures |
|---|---|---|---|---|
| EBS | Warning | Check Host Credential for Smart Clone flows | Check if the EM User has required preferred credential set for "Operating System Username" and "Operating System Password" in "Oracle E-Business Suite Node" target type for the applications context for Smart Clone flows. | If this diagnostic test fails, set the applications context operating system credentials in the "Oracle E-Business Suite Node" target type in the preferred credential store. Name of Command: CheckAppsContextCredentialExistence |
| EBS | Check Database schema credentials for Smart clone flows | Check if the EM User has the required preferred credential set for the APPS schema users in "Oracle E-Business Suite" target type for Smart Clone flows. | The database APPS schema credentials must be entered manually with Smart Clone flows. | |
| EBS | Summary | A summary of all of the diagnostic tests that have been executed, in the following groups: Successful, Failed, With Warning, Aborted, and Total. |
You should run diagnostic tests on your system in preparation for running Patch Manager procedures to ensure your system is set up correctly. For more information on running diagnostic tests, see: How to Run a Diagnostic Test.
The following table lists generic tests related to Patch Manager:
| Step | Test Group | Description | Notes/Expected Results/Corrective Measures |
|---|---|---|---|
| EMGC | Check permissions for OMS Stage directory | Determine if a stage directory is defined on the OMS. Determine if the owner has read/write permissions to that directory. | Expected results are: the OMS Stage Directory Location, with the OMS user with read/write permissions. |
| EMGC | Check Patch Manager Stage directories | Verify if the properties set in the Preferences page have proper definitions for Patch Manager Stage directories | Refer to the section Patch Manager Prerequisites for instructions on completing this step. |
| EMGC | Summary | A summary of all of the diagnostic tests that have been executed, in the following groups: Successful, Failed, With Warning, Aborted, and Total. | |
| EBS | Check if EBS Snapshot in OMS Repository is valid | Verify if the Oracle E-Business Suite snapshot in OMS Repository is valid. | A snapshot shows data about a system for a point in time. If the snapshot is invalid, navigate to the Targets menu > Oracle E-Business Suite and click on the instance name. Then navigate to the Oracle E-Business Suite menu (in the top left corner) > Configuration > Last Collected > Actions > Refresh. |
| EBS | Check for EBS CPU Count | Verify that the target Oracle E-Business Suite system's CPU Count is greater than zero (0). | If there is not a valid snapshot, contact Oracle Support. |
| EBS | Summary | A summary of all of the diagnostic tests that have been executed, in the following groups: Successful, Failed, With Warning, Aborted, and Total. |
The following table lists user-specific tests for Patch Manager.
| Step | Test Group | Description | Notes/Expected Results/Corrective Measures |
|---|---|---|---|
| EMGC | CheckMetalinkCredentials | Verify if username/password credentials are entered for My Oracle Support. | Refer to the Oracle Enterprise Manager documentation for instructions on completing this step. |
| EMGC | Summary | A summary of all of the diagnostic tests that have been executed, in the following groups: Successful, Failed, With Warning, Aborted, and Total. | |
| EBS | CheckPrivilege | Check if the user currently logged in has authority to patch any instances. | Assign privileges as appropriate. |
| EBS | CheckWLSCreds | Check if Oracle WebLogic Server Administration Credentials are set for an Oracle E-Business Suite Release 12.2 instance. | Set the credentials as appropriate. |
| EBS | Check if Preferred Credentials exist | Check if the EM User has the required Preferred Credential set for APPS and SYSTEM schema users in "Oracle E-Business Suite" target type. Check if that user has the required Preferred Credentials for "Oracle E-Business Suite Node" target type for Database Context and for APPL_TOP Context. | Set the preferred credentials as appropriate. |
| EBS | Summary | A summary of all of the diagnostic tests that have been executed, in the following groups: Successful, Failed, With Warning, Aborted, and Total. |
You should run diagnostic tests on your system in preparation for using Customization Manager to ensure your system is set up correctly. For more information on running diagnostic tests, see: How to Run a Diagnostic Test.
The following table lists generic tests related to Customization Manager:
| Step | Test Group | Description | Notes/Expected Results/Corrective Measures |
|---|---|---|---|
| EMGC | CheckOMSStage | Determine if a stage directory is defined on the OMS. Determine if the owner of the directory has read/write permissions to that directory. | Expected results are: the OMS Stage Directory Location and the OMS user with read/write permissions. |
| EMGC | Summary | A summary of all of the diagnostic tests that have been executed, in the following groups: Successful, Failed, With Warning, Aborted, and Total. | |
| EBS | CheckEBSHome | Verify permissions for APPL_TOP. | Verify that the user running the diagnostic test has the correct permissions for the APPL_TOP directory structure. If the test fails, provide the correct Preferred Credentials information in "E-Business Suite" or "E-Business Suite Node". See: Preferred Credentials. |
| EBS | CheckAgentHome | Verify permissions within the Agent home directory. | Verify that the user running the Diagnostic test has the correct permissions for the $AGENT_HOME directory structure. If the test fails, provide the correct Preferred Credentials information in "E-Business Suite" or "E-Business Suite Node". See: Preferred Credentials. |
| EBS | Check Customization Manager related AD Patches for Release 12 | Verify that certain AD patches have been applied on the Oracle E-Business Suite target. | The set of required interoperability patches will vary for the different Oracle E-Business Suite releases. The list of patches is contained in an XML file that might be modified to include or exclude recommended patches. The file is located at: <OMS_HOME>\sysman\admin\emdrep\ebs\testsuites\CMTestSuite.xml. |
| EBS | Check Customization Manager Patches for Release 12 | Verify that certain Customization Manager patches have been applied on the Oracle E-Business Suite target. | The set of required interoperability patches will vary for the different Oracle E-Business Suite releases. The list of patches is contained in an XML file that might be modified to include or exclude recommended patches. The file is located at: <OMS_HOME>\sysman\admin\emdrep\ebs\testsuites\CMTestSuite.xml. |
| EBS | CheckAmpAcp | Verify that the Agent is patched with the latest Oracle E-Business Suite management pack release. The Application Management Pack and the Application Change Management Pack patches are required on both the OMS and Agents. | If the Agent is not at the appropriate release, then it will need to be installed or upgraded through Oracle Universal Installer. |
| EBS | GetAPPSConfigVariables | Check if the context property JDBC_URL is available. | The context variable JDBC_URL needs to be set with non-null values for the Customization Manager jobs to proceed successfully. If the test fails, wait until the metric collection occurs, or force evaluation of the metric collection explicitly |
| EMGC | Summary | A summary of all of the diagnostic tests that have been executed, in these groups: Successful, Failed, With Warning, Aborted, and Total. |
The following table lists user-specific tests for Customization Manager.
| Step | Test Group | Description | Notes/Expected Results/Corrective Measures |
|---|---|---|---|
| EBS | CheckEBSGlobalCred | Check Oracle E-Business Suite Preferred Credentials. This test verifies if the "Applsys Schema", "Apps Schema", and "System Schema" username/password exist; and, if so, if they are valid for a particular instance. | Verify the validity of the credentials supplied for the "Applsys Schema", "Apps Schema", and "System Schema" username/password for the "E-Business Suite" target type in Preferred Credentials. If the test fails, provide the correct credentials for the user in question. See: Preferred Credentials. |
| EBS | CheckAgentHomeWritePermission | Check for write permission within the Agent home directory. | Verify that the user running the Diagnostic test has the correct permissions for the $AGENT_HOME directory structure. If the test fails, provide the correct Preferred Credentials information in "E-Business Suite" or "E-Business Suite Node". See: Preferred Credentials. |
| EBS | CheckWLSCreds | Check if Weblogic Admin Credentials are set for an Oracle E-Business Suite Release 12.2 instance. | If the test fails, provide the correct Preferred Credentials information in "Oracle WebLogic Server". See: Preferred Credentials. |
| EBS | Summary | A summary of all of the diagnostic tests that have been executed, in these groups: Successful, Failed, With Warning, Aborted, and Total. |
The following table has details for generic tests for user monitoring.
| Test | Description | Corrective Actions |
|---|---|---|
| CheckIOPatches | Checks whether the mandatory interoperability patches needed for user monitoring are applied in this Oracle E-Business Suite instance. | Apply the mandatory interoperability patches in the Oracle E-Business Suite instance. |
| CheckRESTHealth | User monitoring uses REST services deployed on the Oracle E-Business Suite instance. This test checks if the REST services are accessible or not. | Check the error message in the report. Refer to the emoms.log for additional information. |
| CheckEBSProfile | Checks if the site-level profile Sign-On:Audit Level is set to 'FORM' in this Oracle E-Business Suite instance. | Set the site-level profile Sign-On:Audit Level to 'FORM'. |
The following table lists user-specific tests for user monitoring.
| Test | Description | Corrective Actions |
|---|---|---|
| CheckEBSGlobalCred | Checks if the preferred credential is set for AppsUserCredSet for this Oracle E-Business Suite instance. | Set the preferred credential. |
| CheckEBSRole | Checks if the Oracle E-Business Suite user, whose credential is set as the preferred credential for AppsUserCredsSet, has the LCM_EM_CLIENT responsibility in this Oracle E-Business Suite instance | Assign the LCM_EM_CLIENT responsibility to the Oracle E-Business Suite user. |