|Oracle E-Business Suite Integrated SOA Gateway Implementation Guide|
Part Number E12169-06
Oracle E-Business Suite Integrated SOA Gateway utilizes Oracle Diagnostics, a tool to help standardize data gathering and troubleshooting. Through the Oracle Diagnostics Framework (ODF), integration repository administrators with appropriate diagnostic roles can run related tests to check the overall health of Oracle E-Business Suite Integrated SOA Gateway and gather interface and deployment information. The diagnostics will help the administrators with ease of maintenance of integration setup and transaction.
You can access Oracle Diagnostics through different user interfaces, including Oracle Applications Manager and other administrative consoles. For more information, see the Oracle Diagnostics Framework User's Guide.
The Oracle E-Business Suite Integrated SOA Gateway diagnostic tests are available in Oracle Diagnostics under the Application Object Library application.
The following topics are included in this chapter:
Use the following steps to run Oracle E-Business Suite Integrated SOA Gateway diagnostic tests and view the reports:
Use the following steps to grant the 'Application Super User Role' (UMX|ODF_APPLICATION_SUPER_USER_ROLE) and 'Diagnostics Super User' roles to a desired user:
Log on to the Oracle E-Business Suite with the username that has the User Management responsibility access privilege.
Click the Users link from the navigation menu to open the User Maintenance window.
Enter information in the search area to locate the appropriate user who you need to assign the roles.
Click the Update icon next to the user with 'Active' account status to open the Update User window.
In the Update User window, click Assign Roles.
In the search window, search for the 'Application Super User Role' (UMX|ODF_APPLICATION_SUPER_USER_ROLE). Choose this role and click Select.
Enter a justification in the Justification filed and click Apply. You will see a confirmation message indicating you have successfully assigned the role.
Repeat step 5 to step 7 to assign the 'Diagnostics Super User' role to the user.
Use the following steps to execute the diagnostic tests for Integrated SOA Gateway and view the reports:
Log on to Oracle E-Business Suite with the username that has been assigned to the above roles.
Select the Application Diagnostics responsibility from the Navigator and click the Diagnose link.
In the Diagnostic Tests window, click Select Application to open the Search and Select: Application pop-up window.
Search for Application Short Name as FND and then click Select to return to the Diagnostic Tests window.
In the Tests column, expand the 'Integrated SOA Gateway' group by clicking on the '+' icon to view all the available diagnostic tests.
Select the diagnostic test you want to execute and then click Execute.
Specify the following information in the Request Details window if needed:
Request Name: This field is populated automatically with the selected test name.
Generate Downloadable Report check box: Select this check box.
Download Format: Select an appropriate value from the drop-down list.
Click Submit to submit your request.
In the View Execution Results window, click Refresh to view the request status. Once the report is generated with 'Completed' status, click View Report to view your report details. Click Download Report to download the report with your selected format.
Oracle E-Business Suite Integrated SOA Gateway provides the following diagnostic tests through Oracle Diagnostics that you can use to check the interface type and deployment information as well as validate the service invocation.
This diagnostic test checks and reports the count of the Oracle Integration Repository public packages by Interface Types (PL/SQL, XML Gateway, and Concurrent Program). It also reports the number of packages that have either been generated or deployed.
This test does not require any input parameters.
For an inputted interface type, this diagnostics test checks and reports the packages and their methods for all the packages which are either Generated or Deployed. Additionally, if the interface type is PL/SQL, it detects if the wrapper packages are valid or not.
Interface Type: This test requires you to enter a valid interface type. Valid inputs are PLSQL, XML Gateway and Concurrent Program.
This diagnostic test checks if the Oracle E-Business Suite Integrated SOA Gateway deployment code works properly.
IREP Class Name: This test requires you to enter the internal name of a package as the IREP Class Name, such as FND_USER_PKG.
It checks and reports the test result if a valid WSDL file is generated upon deployment.
This diagnostic test uses the Service Invocation Framework to call a native Oracle E-Business Suite Web service (using oracle.apps.wf.sif.test.fnd_user_pkg event name and the subscription for fnd_user_pkg.TestUserName operation for the test).
Before running this diagnostic test, ensure the following information is in place:
The FND_USER_PKG interface within the same Oracle E-Business Suite instance needs to be generated and deployed before this diagnostic test can be run.
Once FND_USER_PKG is deployed, the method TESTUSERNAME should be granted to the user using which this invocation is being performed.
This diagnostic test takes four input parameters (User_Name_To_Check, SOAP_User_Name, SOAP_Password_Mod, and SOAP_Password_Key) required for running this test. For description of each input parameter, see Input Required.
The username and password to be used by the service invocation framework for invoking services should be stored in FND vault using a PL/SQL script $FND_TOP/sql/afvltput.sql. For example,
sqlplus apps/apps@db @$FND_TOP/sql/afvltput.sql <Module> <Key> <Value>.
The module name and key to retrieve the password value corresponding to the SOAP user are required to be passed to the SIF diagnostic test as inputs.
For more information about UsernameToken based WS-Security header during Web service invocation, see Supporting WS-Security, Oracle E-Business Suite Integrated SOA Gateway Developer's Guide.
For more information on how to invoke Web services using the service invocation framework, see Implementing Service Invocation Framework.
User_Name_To_Check: This parameter is passed to TESTUSERNAME operation of the FND_USER_PKG Web service to check whether that user exists in the database or not.
Username is needed to be checked by fnd_user_pkg.TestUserName operation.
SOAP_User_Name: This parameter is used in SOAP security header.
SOAP_Password_Mod: This parameter is used in conjunction with Password Key to get the password of above Username from FND vault and that password is used in SOAP security header.
SOAP_Password_Key: This parameter is used in conjunction with Password Module to get the password of above Username from FND vault and that password is used in SOAP security header.
It checks and reports the test result if it gets a correct string response.
This diagnostics test checks the overall health of Oracle E-Business Suite Integrated SOA Gateway.
In order to have the report generated successfully, you must create security grants to authorize the following interfaces access privileges to appropriate users who will execute the report. These interfaces are the SOA Gateway Health Check report running against; therefore, the authorized users must be created first.
SOA Health Check Test Package (SOA_DIAG_TST)
This is the predefined PL/SQL package executed by the SOA Gateway Health Check Report.
Concurrent Program for SOA Health Check Report (SOA_DIAG_TEST)
This is the predefined Concurrent Program executed by the SOA Gateway Health Check Report.
ISG Sample Map (WF:ISGSAMP)
This is the predefined XML Gateway Map executed by the SOA Gateway Health Check Report.
To create a security grant, search for a predefined integration interface first. Next, select the interface method (or procedure and function) from the interface details page (such as select TESTFUNCTION from the SOA_DIAG_TST interface details page) and click Create Grant. Select an appropriate user as a grantee. For more information, see Creating Grants.
To successfully run this report, you should provide the following SOAHeader elements as input parameters. These elements are used to pass values that may be required to set applications context during service execution.
Application User Id
Application User Password
Responsibility Short Name
This test reports the health check details for Integrated SOA Gateway including the following areas:
Integrated SOA Gateway Install Steps Check
It checks and reports the Results of Install Patch Test including the related patch information, patch description, and install status of each patch.
Additionally, it checks if Oracle Application Server Adapter for Oracle Applications is properly installed, as well as if ASADMIN user is properly configured.
Integrated SOA Gateway check for PL/SQL Interface
It checks and reports the statuses of generate/regenerate, deploy, and run-time functions for the predefined PL/SQL package. You could look for more information in the log files.
Integrated SOA Gateway check for XML Gateway Interface
It checks and reports the statuses of generate/regenerate, deploy, and run-time functions for the predefined XML Gateway map. You could look for more information in the log files.
Integrated SOA Gateway check for Concurrent Program Interface
It checks and reports the statuses of generate/regenerate, deploy, and run-time functions for the predefined Concurrent Program. You could look for more information in the log files.
Troubleshooting SOA Gateway Health Check Report
In the case of the report is not run or errors occur while it is running, use the following methods to resolve or troubleshoot the issues:
Enabling the OAM logging to troubleshoot the issue if the report is not run.
Reason: This SOA Gateway Health Check Report uses the logger oracle.apps.fnd.oam.sdk.util.logger.Logger and it only prints the log statements at DEV level. To resolve the issue, enable the OAM logging.
Go to the Oracle Applications Manager Site Map.
In the Others section, click on the Applications Manager Log link. This opens the Oracle Applications Manager Log pop-up window.
Set the Current Log Level to DEV.
Click Go to run the report and look for more information in the log.
Use opatch command to troubleshoot if errors occur while the report is running.
In the opatch section, it indicates if the patch is applied or not. For the interfaces, it gives the fault code. If the above information is not enough to have the issue resolved, enable the OAM logging to DEV level and look at the log information.
Additionally, use the opatch command to get the patches installed information. The opatch command used by this report is as follows:
IAS_ORACLE_HOME+"/OPatch/opatch lsinventory -oh "+IAS_ORACLE_HOME+" -invPtrLoc "+IAS_ORACLE_HOME+"/oraInst.loc
This command can be used from the terminal.
For the services, enable the SOA log and run the report and look for more information.
Copyright © 2008, 2010, Oracle and/or its affiliates. All rights reserved.