Monitoring and Managing Inbound Service Invocation Messages Using Service Monitor

Service Monitor Overview

Service Monitor, previously known as SOA Monitor, is a centralized, light-weight service invocation monitoring and management tool. It fetches data and statistics for each instance of inbound service invocations and associated messages and provides monitoring capability for Oracle E-Business Suite services.

You can view all SOAP messages received and sent from Oracle SOA Suite and REST messages received and sent directly to Oracle E-Business Suite through Service Monitor. Additionally, Service Monitor provides auditing records for the service invocation details if the auditing feature is enabled.

Important: In this release, both SOAP and REST services are monitored and audited through Service Monitor.

For the monitoring purpose, Service Monitor stores basic information about inbound service invocation for all the services, such as instance ID, integration interface details, header information, start date, end date, status, and other information depending on the service type. It does not store request and response payloads, fault message, or attachments unless the auditing feature is turned on for a desired service type of an interface.

Important: Enabling Service Auditing Feature Using the Configuration Subtab

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

For more information on enabling the auditing feature along with log configuration, see Adding a New Configuration.

When the auditing feature is enabled for a service type of an interface, Service Monitor saves the corresponding payloads, fault messages, and attachments if they are available for an instance. This provides additional audit trails for integration administrators to quickly retrieve service invocation details and identify errors or exceptions if occurred.

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 inbound invocations for Oracle E-Business Suite services in the Service Monitor subtab, managing log and audit setups for inbound services in the Configuration subtab, and monitoring outbound service invocations through Service Invocation Framework in the Invocation Monitor subtab.

Monitor Search Page

the picture is described in the document text

Integration administrators can perform the following activities through Service Monitor:

Searching SOAP and REST Requests

In the Search region, you can perform searches on the SOAP requests received and sent from Oracle SOA Suite and the REST requests received directly in Oracle E-Business Suite based on the criteria you specified.

Service Monitor allows you to search SOAP and REST requests by interface name, operation name, request received time, service type, interaction pattern, and request status.

Based on the Service Type value your selected, you can select an appropriate value for the Interaction Pattern field:

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', or 'Today'. By default, 'This Week' is selected.

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 user name and a selected time frame.

When the search is processed, 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, service type, interaction pattern, date and time the request was received and responded, user name, request status, and log.

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

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

The service auditing feature is enabled at the service type level of an integration interface 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 interface name, operation name, request received time, service type, interaction pattern, and request status for your search. Click Go to run 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 user name.

    Click Go to run your search.

  4. All requests that match your search criteria appear.

  5. Click the Instance ID link for a given ID to view the request and response details in the Service Instance page.

  6. Click the Web Service Name link for a given request to view the interface details.

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

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

Viewing SOAP and REST Request and Response Details

After you perform a search, all SOAP and REST messages that match your criteria are retrieved. To view the request and response details for a given instance, click the Instance ID link for a desired instance listed in the search result table. The Service Instance page appears for the selected instance with SOAP or REST service type.

Viewing SOAP Request and Response Details

If you click an instance ID that is for a SOAP message, the Service Details page appears where you can view the selected SOAP service details.

Service Details Page for Viewing SOAP Request and Response Details

the picture is described in the document text

General interface information is shown at the top of the page. It includes interface name, user name, operation name, interaction pattern, auditing information, execution time, responsibility, NLS language, and security group name.

Note: The application context fields (such as responsibility, NLS language, and security group name) display the values passed that are required during the service invocation. These context values may be retrieved from the SOAP Header for a SOAP request.

Clicking an interface 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 appear:

Viewing REST Request and Response Details

If the selected instance ID is for a REST message, the Service Instance page appears where you can view the selected REST service details.

Service Instance Page for Viewing REST Request and Response Details

the picture is described in the document text

General interface information is shown at the top of the page. This header information includes interface name, operation name, interaction pattern, service type, HTTP verb, authentication type, status, HTTP response status, execution time, and auditing information.

Clicking an interface name link launches the interface details page for the REST service in Integration Repository.

In addition to the general header, the following regions appear:

Viewing Log Messages

If the runtime logging is enabled for a specific service type of an 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 type of the interface.

At runtime, each request is received and appears in Service Monitor with an instance ID and the Log icon. You can view the runtime log details by clicking the Log icon.

For information on viewing the runtime processing log messages in the Web Service Runtime Logs page, refer to Viewing Runtime Processing Logs.

Purging SOAP and REST Messages, Audits, and Logs

Oracle E-Business Suite Integrated SOA Gateway lets you purge SOAP and REST 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.

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. Service Monitor will purge all monitored data for SOAP services, REST services, or both SOAP and REST services within your specified date range.

The monitored requests and responses of the selected service type(s) will be purged for the specified date range in the following order of sequence:

  1. Request details

  2. Request and response payloads

  3. Attachments (SOAP only)

  4. 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 a 'FAILURE' status.

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

  5. SOA composite instances from Oracle SOA Suite (SOAP only)

Note: For SOAP services, log messages retrieved from the server file system of Oracle SOA Suite cannot be purged. However, log messages coming from Oracle E-Business Suite service invocation which are stored in the log message table can be purged from the Oracle E-Business Suite database.

To purge 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. Select a desired Service Type value (SOAP, REST, or Any) for your purge.

    3. 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 service requests and responses, Service Monitor provides auditing feature letting you track message details such as requests, responses, and faults.

If the auditing feature for a specified service type of an interface is enabled, all incoming REST messages sent and received directly to Oracle E-Business Suite or all incoming SOAP messages for the service that Oracle SOA Suite processes along with the associated payloads, and fault messages can be saved and tracked in Service Monitor.

Note that the auditing feature is enabled at the service type level of an interface through the Log & Audit Setup Details page in the Configuration subtab.

Log & Audit Setup Details Page for Enabling Auditing

the picture is described in the document text

To enable the auditing feature, select a desired service type (SOAP or REST) of an 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.

Note: To enable the auditing feature for both the SOAP and REST service types of the same interface if both types are available for that interface, you need to create two separate configurations for each service type.

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