For service-enabled interfaces, SOAP service information is displayed in the Web Service region (or the SOAP Web Service tab if the interfaces can also be exposed as REST services) no matter if the selected interface is currently exposed as a Web service or not.
Note: Web service is defined in a way that the interface forms the service and the methods or functions within the interface are defined as the operations of the service.
By default, an interface is not exposed as a SOAP service. Hence, the service status is 'Not Generated'. An integration administrator may transform the selected interface into a SOAP Web service. Once the service for the selected interface has been successfully generated, the service status will be changed from 'Not Generated' to 'Generated'.
The following fields are common in the Web Service region or the SOAP Web Service tab to almost all interface types:
| Field | Description |
|---|---|
| Interaction Pattern table | This table displays the interface name along with the method names contained in the interface in a table. An integration administrator or an integration developer must select appropriate interaction patterns either at the interface level or at the method level before service generation. After service generation, the selected interaction patterns are displayed for the interface or for specific methods contained in the interface. Click the interface name node to expand and view the interaction pattern selection for all the methods within the interface. Please note that this table is still updatable after service generation, but any changes to the table will be applied only after regenerating the service. For more information on each field in the table, see Interaction Pattern Table. |
| Web Service Status (or SOAP Service Status if it's in the SOAP Web Service tab) | This field indicates different state of a SOAP service during service generation and deployment life cycle.
In addition to 'Not Generated', 'Generated', 'Deployed' with 'Active' state, and 'Deployed' with 'Retired' state, more intermediate SOAP service statuses can be shown while the service is in the process of performing an action issued by the administrator and transforming to a different state. The following list describes intermediate Web service status information:
|
| View WSDL | This link is displayed after a selected interface has an associated SOAP service available. Click this link letting you review WSDL description for a generated or deployed service. See: Reviewing Web Service WSDL Source. |
| Interaction Pattern | After service generation, this information is displayed which corresponds to the selected interaction patterns in the Interaction Pattern table. For example, if 'Synchronous' is selected for a specific method contained in a PL/SQL interface, and 'Asynchronous' is selected for another method within the interface, then both 'Synchronous' and 'Asynchronous' are shown in this field. Note: XML Gateway, Concurrent Program, and Business Service Object interfaces can be service enabled only with synchronous support. Therefore, 'Synchronous' is displayed in the Interaction Pattern field for those interfaces by default if the service is available. |
| Authentication Type | To secure Web service content and authenticate Web service operation, before deploying a generated service, an integration administrator must select one desired authentication type for the selected service in the Authentication Type field.
Only users who have the Integration Administrator role can select and modify the authentication type. For other users, this field is displayed in read-only mode. |
Oracle E-Business Suite Integrated SOA Gateway supports service generation synchronously, asynchronously, or both synchronously and asynchronously based on the selection made by the administrator or the integration developer in the Interaction Pattern table.
Interaction Pattern Selection
Before service generation, the administrator or the integration developer must select appropriate interaction patterns either at the interface level or at the method level by expanding the interface name node to list all the methods within the interface.
After service generation, the Interaction Pattern table is still updatable, but any changes will be applied only after service regeneration.
Note: In this release, asynchronous SOAP service operation is supported only in PL/SQL interface. Other SOAP service-enabled interface types including XML Gateway, Concurrent Program, and Business Service Object can be exposed as SOAP services only with the synchronous support.
The following table describes each field in the Interaction Pattern table:
| Field | Description |
|---|---|
| Display Name | This is the interface name used externally. |
| Internal Name | This is the interface name used internally. It can be PL/SQL package name, the document name, or the Java service interface name. |
| Synchronous | If the 'Synchronous' check box is selected for an interface or a specific method, the service or selected operation is generated with the support for synchronous interaction pattern. That is when Web service client sends a SOAP request for this service, service executes and provides an immediate response to the Web service client. |
| Asynchronous | If the 'Asynchronous' check box is selected for an interface or a specific method, the service or selected operation is generated with the support for asynchronous interaction pattern. This type of service execution may require a significant amount of time to process a request. However, the client that invoked the Oracle E-Business Suite Web service can continue with other processing in the meantime rather than waiting for the response. In this release, asynchronous operation is supported in PL/SQL interface only. |
| Grant | If the access permission of an operation has been granted to a specific user, user groups, or all users, then the Grant icon is available for the operation. Only users who have the Integration Administrator role and the Integration Developer role can find the Grant icon and view the grant details. The Grant icon is shown only in the SOAP Web Service tab. |
Performing Administrative Activities for SOAP Web Services
Users who have the Integration Administrator role can perform administrative tasks. These tasks include generating, deploying, undeploying, resetting, retiring, and activating SOAP services by clicking the following buttons in the interface details page:
Generate: This allows an integration administrator or an integration developer to generate a SOAP service.
Note: Integration developers have the privilege to generate the services, but they do not have privileges to perform other administrative tasks including deploying, undeploying, and managing SOAP services throughout the life cycle.
For information about these roles and their associated privileges to administer and view SOAP services, see Accessing Oracle Integration Repository.
Before service generation, desired interaction patterns must be selected first for an interface or specific methods contained in the interface. Once the service has been successfully generated, the SOAP service status is changed from 'Not Generated' to 'Generated'. Additionally, the View WSDL link appears letting you view the WSDL description for the generated service.
After service generation, the administrator can regenerate, deploy, or reset the generated service if it's needed.
For more service generation information, see Generating SOAP Web Services.
Deploy: If the SOAP service has already been successfully generated, Deploy appears in the Web Service region (or the SOAP Web Service tab if the interface can be exposed as both SOAP and REST services) for the selected interface.
Prior to deploying a service, the administrator must select one of the following authentication types. This allows Service Provider to authenticate the users based on the selected type.
Username Token
This authentication type provides username and password information. The username is the concept of Oracle E-Business Suite username/password (or the username/password created through the Users window in defining an application user).
SAML Token (Sender Vouches)
This authentication type is used for Web services relying on sending a username only through SAML Assertion.
Click Deploy to deploy the generated service to Oracle SOA Suite with 'Active' state. This active deployed service is ready to be invoked and accept new SOAP requests.
Once a service has been successfully deployed, the View WSDL link appears letting you view the deployed WSDL details. The administrator can retire, undeploy, or reset the deployed service if it's needed.
For more service deployment information, see Deploying and Undeploying SOAP Web Services.
Retire: This disables an active deployed service so that the retired service will not accept new requests. This action also ensures that current running requests are finished. Once a service has been successfully retired, the SOAP service status is changed to 'Deployed' with 'Retired' state.
Once an active service has been successfully retired, the administrator can activate, undeploy, or reset the retired service if it's needed.
For more information on retiring services, see Retiring SOAP Web Services.
Activate: For a retired service in Oracle SOA Suite, the administrator can activate the service by clicking Activate. This takes a retired service back to active state again. The service can be invoked and accept new SOAP requests.
Once a service has been successfully activated, the administrator can retire, undeploy, or reset the active service if it's needed.
For more information on activating services, see Activating SOAP Web Services.
Reset: Once a service has been successfully generated or deployed, the administrator can clear up existing service artifact at any time by clicking Reset. This action takes the current state of the service to its initial state - 'Not Generated' no matter if it is 'Generated', 'Deployed' with 'Active' state, or 'Deployed' with 'Retired' state.
Once a service has been successfully reset, the administrator can generate the service again if it's needed.
For more information on resetting services, see Resetting SOAP Web Services.
Create Grant: The administrator can create security grants by authorizing access permissions of interface methods to a user, a user group, or all users.
In addition to creating grants, the administrator can revoke the grants for an authorized user, user group, or all users if it's needed.
The grant feature applies to both SOAP and REST service operations if the selected interface can be exposed as both SOAP and REST services. For more information on security grants, see Managing Grants.
Configure: This displays the Log & Audit Setup Details page where the administrator can configure a new design-time log for the selected interface, or update an existing configuration.
Use design-time logs to troubleshoot any issues or exceptions encountered during service generation and deployment life cycle.
Please note that logging is supported only for SOAP services. For more information on log configurations, see Accessing the Logging Configuration User Interface.
View Log: This displays the Log & Error Details page where you can view log details. If errors occurred during each stage of SOAP service life cycle activities, then error messages will also be displayed.
Only if the design-time log is enabled for the selected interface, View Log would appear in the interface details page. Otherwise, View Error appears instead if errors occurred while performing the design-time activities. Click View Error to view the error details only in the Log & Error Details page. For more information on viewing logs recorded at design time, see Viewing Generate and Deploy Time Logs.
To view logs written in Service Monitor during the invocation of Oracle E-Business Suite SOAP services, see Viewing Service Processing Logs.
Additional Information: In addition to performing service management activities in the Integration Repository tab, integration administrators can perform other administrative tasks in the Administration tab that are outside the Integration Repository user interface. These tasks include:
Monitoring and Auditing SOAP Messages in the Service Monitor Subtab
Integration administrators can monitor and audit all SOAP messages received and sent from Oracle SOA Suite for Oracle E-Business Suite Web services using Service Monitor.
With the monitoring and auditing features, any operation errors if occurred during the message exchanges can be easily identified and audited. The administrators can search and view SOAP request and response message details, and take necessary actions.
For information on how to use Service Monitor, see Monitoring and Managing SOAP Messages Using Service Monitor.
Managing Log and Audit Setups in the Configuration Subtab
Integration administrators have the privileges to configure log settings and enable service auditing feature at the integration interface level. With this logging feature, the administrators can easily monitor service activities, track and view log messages, and troubleshoot any issues encountered at each stage of SOAP service development life cycle.
For information on log configuration, see Logging for Web Services.