Custom integration interfaces are annotated based on Integration Repository annotation standards for the supported interface types. The behavior of these interfaces is the same as Oracle seeded interfaces except they are not native packaged, but custom ones. As a result, an integration administrator uses the same approach of managing native interfaces to manage custom interfaces and services.
These administrative tasks include:
For Custom Integration Interfaces with Support for SOAP Web Services
For Custom Integration Interfaces with Support for REST Web Services
For Custom Composite Integration Interface
Viewing Uploaded Custom Integration Interfaces from the Integration Repository
Use the following ways to locate custom interfaces:
From the Interface List page, select 'Custom' from the Interface Source drop-down list along with a value for the Scope field to restrict the custom integration interface display. The search criteria 'Oracle' in the drop-down list is used for searching seeded interfaces.
From the Search page, click Show More Search Options and select 'Custom' from the Interface Source drop-down list along with any interface type, product family, or scope if needed as the search criteria.
For example, select 'Custom' as the Interface Source and 'PL/SQL' as the Interface Type to locate the custom interfaces for PL/SQL type.
For more information on how to search for custom integration interfaces, see the Oracle E-Business Suite Integrated SOA Gateway User's Guide.
To let appropriate users use these newly uploaded custom integration interfaces, the administrators can select one or more methods contained in a given custom interface and then grant the selected method access permissions to a user, user group, or all users.
For interfaces with the support for SOAP services only, security grants are managed in the Methods region of the interface details page. For more information about managing grants for interfaces with the support for SOAP services only, see Managing Security Grants for SOAP Web Services Only.
Once custom integration interfaces have been uploaded to Oracle Integration Repository, an integration administrator or an integration developer can transform these interface definitions into WSDL descriptions if the interface types they belong to can be service enabled.
To generate a Web service, the administrator must first locate a custom interface, and then specify the interaction pattern either at the interface level or the method level before clicking Generate in the interface details page.
If the Web service has been successfully generated, a WSDL link appears along with the 'Generated' Web service status information displayed in the Web Service region (or the SOAP Web Service tab if the interface can be exposed as both SOAP and REST services). The selected interaction pattern information ('Synchronous', 'Asynchronous', or both Synchronous and Asynchronous) for the selected custom service is also displayed.
For detailed information on how to generate SOAP services on native integration interfaces, see Generating SOAP Web Services.
Once a Web service has been successfully generated for a custom interface, like native packaged interfaces, the administrator will perform the same deployment activity to deploy the generated service to an Oracle SOA Suite WebLogic environment with Active state. Before deploying the custom service, the administrator must select one authentication type to authenticate the Web service.
The administrator can undeploy the service if needed.
Note: Similar to the native Oracle E-Business Suite services, the deployed WSDL URL for the custom service shows the physical location of service endpoint where the service is hosted in soa-infra in this release. If your system is upgraded from a previous Oracle E-Business Suite release, after the upgrade to Release 12.2, the deployed WSDL URL information for the custom service has already been changed. Therefore, you may need to replace it with the new WSDL URL and service location or address accordingly in Web service clients while invoking the deployed custom service.
For detailed information on how to deploy or undeploy SOAP Web services, see Deploying and Undeploying SOAP Web Services.
Once a custom service has been successfully generated or deployed, Reset appears in the Web Service region (or the SOAP Web Service tab if the interface can be exposed as both SOAP and REST services) allowing you to reset the 'Generated' or 'Deployed' Web service status to its initial state - 'Not Generated' if needed. This feature clears up the custom service artifact for a given service regardless of its current state.
For more information, see Resetting SOAP Web Services.
When a custom service has been successfully deployed to Oracle SOA Suite with active state, this deployed custom service is ready to accept new requests.
The administrator can change the active state of a deployed custom service by clicking Retire in the Web Service region (or the SOAP Web Service tab if the interface can be exposed as both SOAP and REST services). This retires a deployed custom service and it will no longer accept new requests.
For a retired custom service, the administrator can activate the retired service so that it can become active again.
For more information on retiring SOAP Web services, see Retiring SOAP Web Services.
For a custom service that has been retired, you can activate it by clicking Activate in the interface details page. This action allows a retired custom service to become active again.
For more information on activating Web services, see Activating SOAP Web Services.
Similar to the native business events, the administrator can subscribe to a custom business event by clicking Subscribe from the business event interface details page. Internally, an event subscription is created for that selected event with WF_BPEL_QAGENT Out Agent.
Once an event subscription for that custom event has been successfully created, Unsubscribe appears instead. Clicking Unsubscribe removes the event subscription from the WF_BPEL_Q queue.
For more information on subscribing to business events, see Subscribing to Business Events.
After custom interfaces that can be exposed as REST services are uploaded to the Integration Repository, the administrator can deploy the custom REST services.
Before deploying a custom interface as a REST service, the administrator must specify service alias for the selected interface and select one or more methods from the Service Operations table. Additionally, if the selected interface type is Java Bean Services or Application Module Services, the administrator needs to specify HTTP verbs for desired Java or Application Module methods contained in the selected interface before deployment.
If the service has been successfully deployed, the REST Service Status field is updated to 'Deployed' from 'Not Deployed' indicating that the deployed REST service is ready to accept new service requests.
For more information on deploying REST services, see Deploying REST Web Services.
If a custom REST service has been successfully deployed to an Oracle E-Business Suite managed server, Undeploy appears in the REST Web Service tab. Undeploying a REST service not only brings the deployed REST service back to the Integration Repository, but also resets its status to its initial state - 'Not Deployed'.
For more information on undeploying REST services, see Undeploying REST Web Services.
Similar to managing grants for the interfaces with the support for SOAP services only, the administrators can create grants by selecting one or more methods contained in a given custom interface and then grant the selected method access permissions to a user, user group, or all users. However, for interfaces that can be exposed as REST services, security grants are managed in the Grants tab instead.
Once an access permission to a procedure is authorized to a grantee, it grants the permission to access the associated SOAP and REST service operations simultaneously. For more information about managing grants for interfaces with the support for SOAP and REST services, see Managing Security Grants for SOAP and REST Web Services.
Viewing Custom Composite Services
To view a custom composite service, from the Search page select 'Composite' from the Interface Type field. Click Show More Search Options and select 'Custom' from the Interface Source drop-down list along with any product family or scope as the search criteria.
click a custom composite service from the search result to display the composite service details.
Downloading Custom Composite Services
The administrators can click Download Service in the interface details page to download the relevant custom composite files aggregated in a .JAR file to your local directory.
For more information on how to view and download a composite service, see: