Working with Custom Integration Interfaces and Services

Overview of Custom Integration Interfaces

Oracle Integration Repository provides the capability to display annotated custom integration interfaces that are created for native and composite services.

Integration developers create and annotate custom integration interfaces based on the Integration Repository annotation standards. These annotated source files can then be uploaded to the Integration Repository through backend processing.

Since custom interface definitions can be created for various interface types, including custom interface definitions for XML Gateway Map, Business Event, PL/SQL, Concurrent Program, Business Service Object, Java, Java Bean Services, Application Module Services, and Composite Service for BPEL type, these annotated interface definitions are merged into the interface types they belong to and displayed together with Oracle interfaces from the Integration Repository browser window.

Note: Please note that custom interface types of EDI, Open Interface Tables, and Open Interface Views interfaces are not supported in this release.

Oracle Integration Repository currently does not support the creation of custom Product Family and custom Business Entity.

To easily distinguish annotated custom interface definitions from Oracle interfaces, Oracle Integration Repository provides the following capabilities:

Ability to restrict display of custom or Oracle interfaces (seeded) in the Interface List page from the navigation tree
Ability to search on custom or seeded integration interfaces for a product family in the Search page

The interface details page displays an additional value indicating whether this interface is a custom or seeded one.

For Integration Repository annotation standards, see Integration Repository Annotation Standards, Oracle E-Business Suite Integrated SOA Gateway Developer's Guide.

This section discusses the following topics:

Searching Custom Integration Interfaces

You can find custom integration interfaces in the following ways:

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 interfaces display.

Interface List Page with "Custom" Selected as the Interface Source
From the Search page, click Show More Search Options to select 'Custom' from the Interface Source drop-down list along with any interface type, product family, or scope if needed as the search criteria.

Search Page with "Custom" Selected as the Interface Source

For example, select 'Custom' as the Interface Source and 'PL/SQL' as the Interface Type to locate the custom interfaces for PL/SQL type.

To view the custom integration interface details page:

Log on Oracle E-Business Suite with the Integrated SOA Gateway responsibility. Select the Integration Repository link to open the repository browser.
You can locate custom integration interface definitions from the following two ways:
- From the Interface List page
  
  Select the following values:
  - Interface Source: Custom
  - Scope: Select an appropriate value
- From the Search page
  1. Click Show More Search Options to open more search options.
  2. Select the following values:
    - Interface Source: Custom
    - Scope: Select an appropriate value
    - Product Family: Select an appropriate value
Click Go to execute the search.

Custom integration interfaces that match your search criteria should be displayed in a table format.
Select a custom integration interface name link from the search result to view the interface details.

Note that the custom integration interface details page shows 'Custom' as the Interface Source value allowing you to differentiate it from Oracle seeded interfaces.

Viewing Custom Interface Details

After performing a search on custom integration interfaces either from the Interface List page or from the Search main page, you can view the details page for a selected custom integration interface from the search result.

Select a custom integration interface name link from the search result table, the interface details page appears where you can find the interface name, description, and other annotated information.

Please note that all custom integration interface definitions have 'Custom' value in the Interface Source field and this value distinguishes it from a seeded one.

Users who have the Integration Repository Administrator role can perform the following tasks:

For the custom interface that can be exposed as SOAP Web service
- Generate SOAP Web services
- Deploy (undeploy or redeploy) SOAP Web services
For the custom interface that can be exposed as REST Web service
- Deploy REST Web services
- Undeploy REST Web services

For more information about these administrative tasks, see Performing Additional Web Service Activities for Custom Integration Interfaces.

Performing Additional Web Service Activities for Custom Integration Interfaces

In addition to viewing custom integration interface details, users with administrator role can perform the following administrative tasks:

For Custom Integration Interfaces with Support for SOAP Web Services
- Generating Custom SOAP Web Services
  
  Users who have the Integration Repository Administrator role can find Generate WSDL (or Generate for the custom PL/SQL interface) available in the interface details page. Clicking Generate WSDL (or Generate) automatically generates the custom SOAP service with corresponding WSDL file. See: Generating SOAP Web Services, Oracle E-Business Suite Integrated SOA Gateway Implementation Guide.
- Deploying Custom SOAP Web Services
  
  If the custom service has already been generated successfully, users who have the Integration Repository Administrator role can find Deploy available for the selected custom integration interface. Prior to deploying the service to the application server, the administrator must first select at least one authentication type for the generated service supported by SOA Provider.
  
  If the service has been successfully deployed, the Web Service Status field will be updated to 'Deployed'. The View WSDL link appears along with the selected authentication type(s) for the deployed custom web service.
- Redeploying or Undeploying Custom SOAP Web Services
  
  The following buttons appear if a custom web service has been successfully deployed:
  - Redeploy:
    
    This allows the administrators to redeploy the custom service when needed. If changes are made to the Authentication Type field for the deployed service, the administrator must redeploy the custom web service.
  - Undeploy: This allows the administrators to undeploy the custom service that has been deployed earlier.
  See: Deploying and Undeploying SOAP Web Services, Oracle E-Business Suite Integrated SOA Gateway Implementation Guide.
- Viewing Log Messages
  
  To effectively troubleshoot any issues or exceptions encountered at each stage of service development and deployment life cycle, the administrators can view design-time logs through the Interface Details page and runtime logs through the SOA Monitor user interface for the service or operation if the logging is enabled and configured properly at required logging category level.
  
  For information on how to view design-time logs, see Viewing Generate and Deploy Time Logs, Oracle E-Business Suite Integrated SOA Gateway Implementation Guide.
  
  For information on how to view log messages through SOA Monitor, see Viewing Service Processing Logs, Oracle E-Business Suite Integrated SOA Gateway Implementation Guide.
For detailed information about each administrative task listed here, see Administering SOAP Web Services, Oracle E-Business Suite Integrated SOA Gateway Implementation Guide.
For Custom Interfaces with Support for REST Web Services

Note: Supported interfaces for custom REST services are PL/SQL APIs, Concurrent Programs, Business Service Objects, Java Bean Services, and Application Module Services. Although Open Interface Tables and Views can be exposed as REST services, custom interfaces of this interface type are not supported.
- Deploying Custom REST Web Services
  
  Before deploying a custom interface as a REST service, the administrator must specify service alias for the selected interface. If the selected custom interface type is Java Bean Services, Application Module Services, or Business Service Object, the administrator also needs to specify HTTP verbs for the desired methods contained in the selected interface before deployment.
  
  If the custom REST service has been successfully deployed, the REST Service Status field is updated to 'Deployed' from 'Not Deployed'. This indicates that the active service is ready to accept new service requests.
  
  For more information on deploying custom REST services, see Deploying REST Web Services, Oracle E-Business Suite Integrated SOA Gateway Implementation Guide.
- Undeploying Custom REST Web Services
  
  If a custom service has been successfully deployed, the administrators can click Undeploy to undeploy the REST service if necessary and at the same time to reset the service status to its initial state - 'Not Deployed'.
  
  For more information on undeploying REST services, see Undeploying REST Web Services, Oracle E-Business Suite Integrated SOA Gateway Implementation Guide.
For detailed information about administrative tasks, see Administering REST Web Services, Oracle E-Business Suite Integrated SOA Gateway Implementation Guide.
For Business Events

The administrators can subscribe to a business event by clicking Subscribe in the business event interface details page. This creates subscription for the selected event.

For information on how to subscribe to an event, see Subscribing to Business Events, Oracle E-Business Suite Integrated SOA Gateway Implementation Guide.
For Custom Composite Integration Interface
- Viewing Custom Composite Services
  
  You can view custom composite service details including the associated WSDL file for a selected custom composite service.
  
  To locate a custom composite service, you can perform a search from the Search page. Click Show More Search Options to display more search fields. Enter the following values in the Search page along with product family, scope, or any other values if needed as criteria:
  - Interface Source: Custom
  - Interface Type: Composite
  can view a custom composite service details, and download the .ZIP file for a composite service if it is available for download.
  
  For more information on viewing composite services, see Viewing Composite Services.
- Downloading Custom Composite Services
  
  Similar to downloading native packaged composite services, users who have the download privilege can download a custom composite - BPEL .JAR file to their local directories by clicking Download Service in the interface details page.
  
  For more information on how to download a composite service, see Downloading Composite Services, Oracle E-Business Suite Integrated SOA Gateway Implementation Guide.