Monitoring and Managing SOAP Messages Using Service Monitor

This chapter covers the following topics:

Service Monitor Overview

Service Monitor, previously known as SOA Monitor, is a centralized, light-weight service execution monitoring and management tool. It fetches data and statistics for each instance of a Web service request and response and provides monitoring capability for Oracle E-Business Suite Web services.

You can view all runtime SOAP request and response data received and sent from Oracle SOA Suite through the Service Monitor user interface in Oracle E-Business Suite. Additionally, Service Monitor provides auditing records for the service execution details if the auditing feature is enabled.

Important: Only SOAP services are monitored and audited through Service Monitor. Runtime REST service monitoring and auditing features are not supported in this release.

For the monitoring purpose, Service Monitor stores basic information about service execution for all the services such as instance ID, integration interface details, SOAP header, start date, end date, status and so on. Please note that it does not store SOAP request and response payloads along with the attachments unless the auditing feature is turned on.

When the auditing feature is enabled, Service Monitor saves the payloads of SOAP requests and responses, fault messages, and attachments if they are available for an instance. This auditing feature provides additional audit trails for integration administrators to quickly retrieve service execution details as well as identify errors or exceptions if occurred.

Important: Enabling Service Auditing Feature Using the Configuration Subtab

For the monitoring feature, Service Monitor is a permanent monitoring tool and it is enabled at all times to monitor all Oracle E-Business Suite Web services. However, its auditing feature needs to be explicitly enabled at the interface or service level through the Log & Audit Setup Details page.

For more information on how to enable the auditing feature along with log configuration at the interface or service level, see Adding a New Configuration.

Accessing Service Monitor

To access Service Monitor, log in to Oracle E-Business Suite as a user who has the Integration Administrator role.

Select the Integrated SOA Gateway responsibility from the navigation menu and then select the Administration > Service Monitor link. The Service Monitor subtab is displayed with the Monitor Search page.

Note: The Administration selection from the navigation menu appears only to the users who have the Integration Administrator role after logging in to Oracle E-Business Suite with the Integrated SOA Gateway responsibility.

All administrative tasks performed outside the Integration Repository user interface are grouped and displayed under the Administration tab. These tasks include monitoring SOAP requests in the Service Monitor subtab and managing log and audit setups in the Configuration subtab.

Monitor Search Page

the picture is described in the document text

Integration administrators can perform the following activities through Service Monitor:

Searching SOAP Requests

In the Search region, you can perform searches on SOAP requests received from Oracle SOA Suite based on the criteria you specified.

Service Monitor allows you to search SOAP requests by instance ID, interaction pattern, request status, Web service name, operation name, and request received time.

The Interaction Pattern field drop-down selection includes asynchronous pattern support in addition to synchronous operation. You can select an appropriate value from the selection such as 'Any', 'Synchronous Request-only', 'Asynchronous Request-only', 'Synchronous Request-Response', or 'Asynchronous Request-Response'.

The Request Received time can be selected from the list of values. Its value can be 'Any Time', 'Last 2 Weeks', 'Last 30 Days', 'Last 60 Days', 'Last 90 Days', 'This Week', and 'Today'.

Note: All the list of value selections from the Request Received field will include the requests received day of Today except 'Any Time'. For example, 'This Week' means the last 7 days inclusive of today the requests have been received, and 'Last 30 Days' means the last 30 days inclusive of today the requests have been received.

'Any Time' means a blind search of requests received regardless of the Request Received date. If this field is left blank, then 'This Week' is the default value for the Request Received time.

You can optionally enter more search criteria by clicking the Show More Search Options link in the Search region. These criteria include username and a selected time frame.

When the search is executed, all entries that match your search criteria will be retrieved and displayed in a table. Each entry in the result table includes the instance ID, Web service name, operation name, interaction pattern, date and time the request was received and responded, username, and request status.

If service processing log messages are available for an instance, the Log icon is enabled in the result table allowing you to view the log messages.

From the search result page, you can perform the following tasks:

Please note that the Web service auditing feature is enabled at the integration interface level through the Log & Audit Setup Details page. For more information on how to enable or disable the auditing feature, see Adding a New Configuration.

To perform a search:

  1. Log in to Oracle E-Business Suite as a user who has the Integration Administrator role. Select the Integrated SOA Gateway responsibility. From the navigation menu, select the Service Monitor link from the Administration section to open the Monitor Search page.

  2. In the Search region, enter appropriate search criteria including instance ID, interaction pattern, request status, Web service name, operation name, and request received time for your search. Click Go to execute your search.

  3. Optionally, enter more search criteria by clicking the Show More Search Options link to enter the following information:

    • From: Enter an appropriate search start date.

    • To: Enter an appropriate search end date.

    • Username: Search and select an appropriate username.

    Click Go to execute your search.

  4. All SOAP requests that match your search criteria appear.

  5. Click the Details icon for a given instance ID to view the SOAP request and response details.

  6. Click the Log icon, if service processing logs are available for a given instance ID, to view the log details.

  7. Click Purge to purge SOAP requests and responses, audits, as well as log messages collected for a period of time.

Viewing SOAP Request and Response Details

After executing a search, all SOAP messages that match your criteria are retrieved. To view the SOAP request and response details, click the Details icon for a given instance ID listed in the search result table. The Request and Response Details page appears.

SOAP Request and Response Details Page

the picture is described in the document text

General SOAP request heading is displayed at the top of the page. This header information includes Web service name, operation name, interaction pattern, username, responsibility, NLS language, security group name, execution time, and whether the request is audited or not.

Clicking a Web service name link launches the interface details page for the service in Integration Repository. This lets you view the integration interface and service in details.

In addition to the general header, the following regions are displayed in the details page:

To view SOAP request and response details:

  1. Log in to Oracle E-Business Suite as a user who has the Integration Administrator role. Select the Integrated SOA Gateway responsibility.

    From the navigation menu, select the Service Monitor link from the Administration section to open the Monitor Search page.

  2. Perform a search to display the search result. See: Searching SOAP Requests.

  3. Click the Details icon for a given request to view the SOAP request and response details. The Request and Response Details page appears.

  4. Click the SOAP Request or Response View link if available to view the actual XML file for the SOAP request or response message.

  5. If there is any attachment associated with it, the attachment information appears in the Attachment region.

  6. If the SOAP request status is 'Failed', then the Error Information region appears in the Request Details region.

Viewing Service Processing Logs

To effectively monitor SOAP messages at run time during the invocation of Oracle E-Business Suite services by Web service clients, if the runtime logging is enabled for a specific interface or service in the Log & Audit Setup Details page, log messages can be captured in Service Monitor against that instance for the specified service.

When a SOAP request is received, Service Provider generates a unique numeric instance ID based on a database sequence and passes it to Service Monitor. Therefore, each SOAP request in Service Monitor appears with instance ID and the Log icon letting you retrieve the log details.

Click the Log icon in the search result table to view log messages in the Web Service Runtime Logs page.

Important: Runtime logging for PL/SQL, Concurrent Program, XML Gateway interface types is handled by Oracle SOA Suite; therefore, setting runtime log levels for these services in the Log & Audit Setup Details page will display Oracle SOA Suite logs if the services are deployed in Oracle SOA Suite. Limited runtime log statements from the Oracle E-Business Suite Integrated SOA Gateway code (identified by the package name oracle.apps.fnd.isg) will be displayed for these services.

Runtime logging for Business Service Object interface type is handled by Oracle E-Business Suite Integrated SOA Gateway; therefore Service Monitor shows Oracle E-Business Suite Integrated SOA Gateway logs for these interfaces based on the log level selected in the Log & Audit Setup Detail page.

Web Service Runtime Logs Page

the picture is described in the document text

The Web Service Runtime Logs page contains the following log regions:

File Logging and Database Logging

In general, log statements can be captured either in the Oracle SOA Suite server's file system (File Logging) or in the Oracle E-Busines Suite database tables (Database Logging). By default, log statements are captured in the database if logging is enabled from the Log & Audit Setup Details page.

Enhancing Performance for Database Logging

In comparison to file logging, database logging reduces performance of design-time operations. Performance can be improved by setting the optional parameter <sid>.ISG_KEEP_ALIVE_DB_CONN=true in isgagent.properties in Oracle E-Buiness Suite.

Enabling File Logging

File logging is enabled by setting the following properties in isgagent.properties in Oracle E-Buiness Suite and isg.properties in Oracle SOA Suite:

Note: Logging mechanism should be the same across Oracle E-Business Suite and Oracle SOA Suite. If file logging is enabled in Oracle E-Business Suite, then it must be enabled in Oracle SOA Suite as well.

In Oracle E-Business Suite, log files are created in the path specified in the property <SID>.ISG_TEMP_DIRECTORY_LOCATION in isgagent.properties file.

In Oracle SOA Suite server, log file is created in the path specified in the property <SID>.ISG_TEMP_DIRECTORY_LOCATION in $INST_TOP/soa/isg.properties file.

When file logging is enabled, log statements for design-time and runtime operations are not shown in the Interface Details page and Service Monitor user interface.

For information on log severity level and how to configure logs, see Adding a New Logging Configuration.

For information on how to view logs and error messages recorded during service generation and deployment at design time, see Viewing Generate and Deploy Time Logs.

To view log messages in Service Monitor:

  1. Log in to Oracle E-Business Suite as a user who has the Integration Administrator role. Select the Integrated SOA Gateway responsibility.

    From the navigation menu, select the Service Monitor link from the Administration section to open the Monitor Search page.

  2. Perform a search to display the search result. See: Searching SOAP messages.

  3. In the search result table, click the Log icon for a desired instance. The Web Service Runtime Logs page is displayed allowing you to view the log details.

  4. In the Adapter Logs region, click Delete Log to delete all the logs listed in the table for a given instance if needed. Click Yes to confirm the action. Click No to return to the Web Service Runtime Logs page.

    Click Export to export log list table to Microsoft Excel.

Purging SOAP Messages, Audits, and Logs

Oracle E-Business Suite Integrated SOA Gateway allows you to purge SOAP messages, logs stored in the Oracle E-Business Suite database, and audit records that have been collected through Service Monitor for a period of time. Click Purge in the Service Monitor Search page to launch the Service Monitor Purge page.

Note: For log messages retrieved from Oracle SOA Suite's server file system, these log messages cannot be purged. For log messages coming from Oracle E-Business Suite API execution stored in the log message table, these logs can be purged from the Oracle E-Business Suite database.

Service Monitor Purge Page

the picture is described in the document text

Enter the following purge parameters in the Service Monitor Purge page:

Click Submit. A request number will be automatically assigned to you for your purge request indicating that your request has been submitted for processing. When your request is executed, all SOAP requests within your specified date range will be purged.

The monitored SOAP requests and responses will be purged in the following order of sequence:

  1. Purging SOAP requests

    This deletes all SOAP requests for the specified date range.

  2. Purging SOAP body

    This deletes the SOAP body including payload corresponding to those SOAP requests that have been purged (for the specified date range).

  3. Purging SOAP attachment

    This deletes all attachments associated with the SOAP requests and responses for the specified date range.

  4. Purging log messages from the Oracle E-Business Suite database

    This deletes only the logs for which the service is completed with a status of 'SUCCESS'. This does not delete the logs for the service with 'FAILURE' status.

    The purge is based on the Completion Date of the service for the specified date range.

  5. Purging composite instances from Oracle SOA Suite

    This deletes composite instances from Oracle SOA Suite for the specified date range.

To purge SOAP requests and responses:

  1. Log in to Oracle E-Business Suite as a user who has the Integration Administrator role. Select the Integrated SOA Gateway responsibility.

    From the navigation menu, select the Service Monitor link from the Administration section to open the Monitor Search page.

  2. Click Purge.

  3. Enter the following information in the Service Monitor Purge page:

    1. Enter the request name for your purge request.

    2. Enter the Start Date and End Date fields to specify the time range for your purge.

  4. Click Submit to submit your purge request.

Enabling Web Service Auditing Using the Configuration Subtab

In addition to searching and viewing SOAP requests and responses, Service Monitor provides auditing feature allowing you to track SOAP message details such as requests, responses, and faults.

If the auditing feature for a specific service is enabled, all incoming SOAP requests and corresponding responses for the service that Oracle SOA Suite processes along with the associated payloads, and fault messages can be saved and tracked in Service Monitor.

Please note that the auditing feature is enabled at the interface level through the Log & Audit Setup Details page in the Configuration subtab.

Log & Audit Setup Details Page with "On" Selected for Enabling Auditing

the picture is described in the document text

To enable the auditing feature, select the interface that you want the feature to be enabled, and then select 'On' from the Audit drop-down list. Click Apply to save and validate the addition.

For more information on how to enable the auditing feature along with log configuration at the interface level, see Adding a New Configuration.