Oracle E-Business Suite Integrated SOA Gateway allows users who have the Integration Administrator role or the Integration Developer role to transform interface definitions to SOAP services.
SOAP services can be generated with the support for synchronous or asynchronous interaction pattern, or both synchronous and asynchronous patterns. Before generating a service, the integration administrator or the integration developer must specify interaction pattern(s) for desired methods to be exposed as service operations. This can be achieved at the method level for one or more methods, or at the interface level for all methods.
Important: In this release, asynchronous operation is supported only in PL/SQL interfaces in enabling SOAP-based services.
For XML Gateway and Concurrent Program interface types
Each interface contains only one method and it can only be service enabled synchronously by default; therefore, the Interaction Pattern table is neither displayed in the Web Service region for XML Gateway interfaces nor the SOAP Web Service tab for Concurrent Program interfaces.
For Business Service Object interface type
Each interface may contain more than one method; therefore, only the Synchronous column is displayed in the Interaction Pattern table for method selection.
Please note that by default, none of the interaction pattern would be selected. However, if your system is upgraded from a previous release, for backward compatibility, 'synchronous' pattern is selected for all the methods contained in a service.
For more information about synchronous and asynchronous operation patterns, see Synchronous and Asynchronous Web Services.
Generating Services
For interfaces with the support for SOAP services only, service activities are managed in the Web Service region. For interfaces with the support for both REST and SOAP services, these activities are managed in the SOAP Web Service tab of the interface details page.
Once a service is generated, the associated service artifacts are also generated for the selected methods. If only one method is selected, then only that selected method has a service artifact generated.
Note: It's important to note the following for PL/SQL based concurrent program:
Although at a PL/SQL layer, any concurrent programs can be submitted by FND_REQUEST API, Oracle E-Business Suite Integrated SOA Gateway supports calling of different concurrent programs through separate concurrent program services.
There may be PL/SQL based APIs exposed through the Integration Repository that are not consistent with the synchronous, auto-committed transaction state of the Web Service Framework in Oracle E-Business Suite Integrated SOA Gateway.
The WSDL generated by Oracle E-Business Suite Integrated SOA Gateway marks schema elements (parameters) and its related schemas as optional or mandatory, based on the method signature of the underlying API. However, runtime behavior may vary based on API internal implementation.
After Service Generation
The SOAP Web Service tab or the Web Service region contains the following information:
Note: For overloaded functions, sequence number is added to the end of the overloaded method name. Each overloaded function can be uniquely selected and generated with your desired interaction pattern.
Interaction Pattern Table: Selected method names with desired interaction pattern(s) are displayed in the table.
If change on the interaction pattern table is required for a generated service:
If the generated service has not yet been deployed, after modification you must regenerate the service. Upon regeneration, the service definition will be changed to reflect the changes made in the table. You need to modify its Web service clients based on the new service definition.
If the generated service has already been deployed, you must first undeploy the service, modify the pattern selection, regenerate the service, and then deploy the service again.
For information on service deployment, see Deploying and Undeploying SOAP Web Services.
If the generated service is of XML Gateway or Concurrent Program interface type, this table is not displayed.
Web Service Status (or SOAP Service Status): After a service has been generated successfully, the service status is changed from 'Not Generated' to 'Generated'.
Important: Multiple requests to generate Web services for an integration interface are not allowed. If service generation is still in progress, then 'Generating' is displayed as the service status and the Generate button is disabled.
Interaction Pattern: 'Synchronous' is displayed by default in the Web Service region or the SOAP Web Service tab if the selected interface is not a PL/SQL API.
View WSDL Link: Click this link to view the generated WSDL description for the selected interface.
Please note that if a method is exposed as a serviceable operation with the support of asynchronous pattern, then ASYNCH appears in the WSDL for that method to distinguish it from the rest of the operations generated synchronously.
For example, if 'Asynchronous' is selected specifically for the 'CREATE_INVOICE' method within the Invoice Creation API (AR_INVOICE_API_PUB) interface, after service generation, the ASYNCH appears in the CREATE_INVOICE operation for both input and output messages as well as binding.
...
<portType name="AR_INVOICE_API_PUB_PortType">
<operation name="CREATE_INVOICE_ASYNCH">
<input name="tns:CREATE_INVOICE_Input_Msg"/>
</operation>
</portType>
<portType name="AR_INVOICE_API_PUB_Callback_PortType">
<operation name="CREATE_INVOICE_ASYNCH_RESPONSE">
<input name="tns:CREATE_INVOICE_Output_Msg"/>
</operation>
</portType>
...
<binding name="AR_INVOICE_API_PUB_Binding" type="tns:AR_INVOICE_API_PUB_PortType">
<operation name="CREATE_INVOICE_ASYNCH">
<soap:operation soapAction="CREATE_INVOICE_ASYNCH" />
<input>
<soap:header message="tns:CREATE_INVOICE_Input_Msg" part="header" use="literal" />
<soap:body use="literal" parts="body" />
</input>
</operation>
</binding>
<binding name="AR_INVOICE_API_PUB_CallBack_Binding" type="tns:AR_INVOICE_API_PUB_CallBack_PortType">
<soap:binding style="document" transport="http://schemas.xmlsoap.org/soap/http" />
<operation name="CREATE_INVOICE_ASYNCH_RESPONSE">
<soap:operation soapAction="CREATE_INVOICE_ASYNCH_RESPONSE" />
<input>
...
</input>
</operation>
</binding>
For more information about WSDL, see: Reviewing SOAP Service WSDL Source.
After service generation, if the interface definition has been changed or the selected interaction pattern information has been modified before service deployment, you can regenerate the service by clicking Regenerate. However, if interface definition is not changed, then regenerating the service will not change the service definition.
Click Reset to clear up the existing service artifact and change the Web Service Status field from 'Generated' to 'Not Generated'. See: Resetting SOAP Web Services.
To deploy the generated service, the administrator must select one desired authentication type in the Authentication Type region. The selected authentication type will be used to authenticate Oracle E-Business Suite users at run time. For more information on deploying a service, see Deploying and Undeploying SOAP Web Services.
Displaying Generic XML Gateway Service Subregion for Generic XML Gateway Services
For XML Gateway interface type, if your system is upgraded from a previous release and if you have been using generic XML Gateway Web services, the generic XML Gateway service information can be displayed by setting the FND: XML Gateway Map Generic Service profile value to 'Yes'.
In the Web Service region, click the Show Generic XML Gateway Service or Hide Generic XML Gateway Service link to display or close the Generic XML Gateway Service subregion for the selected XML Gateway interface.
For more information on setting profile options, see Setting Profile Options.
In addition to setting profile options, the administrator needs to perform additional setup tasks for generic XML Gateway services. For setup information, see Installing Oracle E-Business Suite Integrated SOA Gateway, Release 12.2, My Oracle Support Knowledge Document 1311068.1 for details.
The Generic XML Gateway Service subregion contains the following fields:
Web Service Status: This field indicates the current state of the selected XML Gateway interface.
If the setup is not configured for generic XML Gateway services, the Web Service Status field is displayed as 'Not Deployed'.
View Generic WSDL: Click the View Generic WSDL link to display the deployed generic WSDL URL for the selected XML Gateway interface.
The deployed generic WSDL URL has the following syntax:
http://<SOA server host>:<SOA Suite managed server port>/soa-infra/services/default/XMLGatewayService!<version chosen while deploying>XMLGateway?WSDL
<SOA Suite managed server port>: It is the port of the server where SOA composite is deployed.
<version chosen while deploying>: At the time of deployment, deployement version will be asked. Default version value is 1.0.
For example, http://<SOA server host>:<SOA Suite managed server port>/soa-infra/services/default/XMLGatewayService!1.0/XMLGateway?WSDL.
Please note that after the upgrade to Oracle E-Business Suite Release 12.2, the deployed WSDL URL information has been changed from an earlier release. Therefore, you may have to replace it with the new WSDL URL and service location or address accordingly in Web service clients while invoking the generic XML Gateway service.
The updated WSDL URL is also populated in the ISG: Generic Service WSDL URL for XMLG profile option by default if the setup tasks for generic XML Gateway services are configured properly.
Interaction Pattern: 'Synchronous' is displayed by default in read-only mode.
Authentication Type: 'Username Token' is displayed by default in read-only mode.
To generate a Web service:
Log in to Oracle E-Business Suite as a user who has the Integration Administrator role. Select the Integrated SOA Gateway responsibility and the Integration Repository link.
In the Integration Repository tab, select 'Interface Type' from the View By drop-down list.
Expand an interface type node to locate your desired interface definition.
Click the interface definition name link to open the interface details page.
If this selected interface definition does not have service generated, specify at least one interaction pattern in the Interaction Pattern table. This can be done at the interface level or at the method level before clicking Generate in the Web Service region to generate the WSDL description.
For interfaces that can be supported with both REST and SOAP services, Generate is located in the Service Operations region of the SOAP Web Service tab in the interface details page.
After service generation, the interaction pattern table and the Interaction Pattern field are displayed with selected pattern information for your interface.
The Web Service Status field marked as 'Generated' also appears which indicates that this selected interface has WSDL description available.
Click the View WSDL link to view the WSDL description.
Click Regenerate to regenerate the WSDL description if necessary.