Oracle E-Business Suite Integrated SOA Gateway User's Guide Release 12.1 Part Number E12064-06

Contents

Previous

Next

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 (except for Java APIs for Forms subtype) 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, Interface Views, and Java APIs for Forms 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

• Viewing Custom Integration Interfaces

• Performing Additional Web Service Activities for Custom Integration Interfaces

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.

  Viewing from Interface List Page

  

• 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.

  Viewing from Interface Search Page

  

  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:

1. Log on Oracle E-Business Suite with the Integrated SOA Gateway responsibility. Select the Integration Repository link to open the repository browser.

2. 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

3. Click Go to execute the search.

   Custom integration interfaces that match your search criteria should be displayed in a table format.

4. Select a custom integration interface name link from the search result to view the interface details.

   Please 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.

From the interface details page, you can perform the following tasks if you have appropriate privileges:

• Generate Web services

• Deploy Web services if they are generated successfully

See Performing Additional Web Service Activities for Custom Integration Interfaces for details.

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 of Interface Types

  • Generating Web Services

    Users with administrator role can find Generate WSDL available in the interface details page. Clicking Generate WSDL automatically creates a corresponding WSDL file. Once the WSDL file is generated successfully, the appropriate Web Service region becomes available. See: Generating Web Services, Oracle E-Business Suite Integrated SOA Gateway Implementation Guide.

  • Deploying Web Services

    If the service has already been generated successfully, users with administrator role can find Deploy available in the Web Service region 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. This allows SOA Provider services the deployment based on the selected type(s).

    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 Web service.

  • Redeploying or Undeploying Web Services

    The following buttons appear if a Web service has been successfully deployed:

    • Redeploy:

      This allows you to redeploy the service when needed. If changes are made to the Authentication Type field for the deployed service, the administrator must redeploy the Web service.

    • Undeploy: This allows you to undeploy the Web service that has been deployed earlier.

    See: Deploying and Undeploying 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 run-time 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.

    How to view design-time logs, see Viewing Design-Time Logs, Oracle E-Business Suite Integrated SOA Gateway Implementation Guide.

    How to view run-time logs, see Viewing Run-Time Logs, Oracle E-Business Suite Integrated SOA Gateway Implementation Guide.

  • Subscribing to Business Events

    The administrator can find Subscribe in the business event interface details page allowing the administrator to subscribe to selected business event and create subscription for the selected event.

    See: Subscribing to Business Events, Oracle E-Business Suite Integrated SOA Gateway Implementation Guide.

  For detailed information about each administrative task listed here, see Administering Native Services, 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 granted with the download privilege can download a custom composite service BPEL .JAR file to your local directory 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.

Copyright © 2005, 2010, Oracle and/or its affiliates. All rights reserved.