Release 12.1
Part Number E12064-06
Contents
Previous
Next
| Oracle E-Business Suite Integrated SOA Gateway User's Guide Release 12.1 Part Number E12064-06 | Contents | Previous | Next |
This chapter covers the following topics:
Oracle E-Business Suite Integrated SOA Gateway is the intrinsic part of Oracle E-Business Suite for service enablement. It provides the capability of invoking services or Web services and allowing services or Web service clients to make use of the services provided from the Suite.
To accomplish this goal, there must be a centralized location where all service related business interfaces can be stored, and at the same time all application users can browse through these business interfaces knowing what type of services are available for business consumption.
Oracle Integration Repository, an integral part of Oracle E-Business Suite, is the repository to serve this purpose. It contains numerous interface endpoints exposed by applications throughout the entire Oracle E-Business Suite and is an essential component within Oracle E-Business Suite Integrated SOA Gateway. This centralized repository not only provides a complete catalog of Oracle E-Business Suite's business interfaces, but also provides a comprehensive, consistent browsing view of the interface mechanism. You can use this tool to easily discover and search on business interfaces, regardless of custom or Oracle packaged ones, from the catalog for integration with any system, application, or business partner.
A business interface is a collection of functions provided for transferring data from one computerized system to another to achieve a specific goal. An Oracle E-Business Suite application might include one or more business interfaces, which enable you to use other Oracle software or third party programs to transfer data to or from the application, or to invoke some aspect of the application's functionality.
Interfaces can be used from application-to-application (A2A), or from business-to-business (B2B). An example of a B2B transaction would be something like that a purchase order acknowledgement interface receives an acknowledgement from a trading partner in response to an outbound purchase order request or change.
Oracle business interfaces are built using a variety of technologies, with each technology appropriate to different environments and tasks. These constitute the available interface types. For example, a business interface can be based on a PL/SQL package. PL/SQL is an interface type that you can find it through the Integration Repository and then locate various PL/SQL based business interfaces grouped by product family.
Note: Oracle Integration Repository supports the following integration interface types which can be categorized as follows:
Service enabled
PL/SQL
XML Gateway Map (inbound)
Concurrent Program
Important: Service enablement for concurrent programs linked to Open Interfaces are currently not supported. This type of concurrent programs can be viewed and displayed under the Open Interface category which is not supported for service enablement.
Business Service Object (Service Beans)
Java APIs for Forms
Note: Java APIs for Forms are XML document-based integration points wrapped in Java classes for executing business logic in Oracle Forms. These specialized Java classes are categorized as a subtype of the Java interface.
Subscription model
Business Event
XML Gateway Map (outbound)
Composite services - BPEL
Non-service enabled public interfaces
Open Interface Tables
Open Interface Views
EDI Interface
Detailed information on each interface type, see Interface Types.
A unified repository from which all integration interface types are exposed.
Updates are automated and documented.
Catalog is searchable on keywords and navigable by product family.
A powerful user interface to help you find the data you are looking for from the repository.
It supports composite services containing a collection of native interfaces.
It enforces security rules to allow only authorized users to perform administrative tasks such as generate and deploy Web services.
You can invoke the repository like any other Oracle E-Business Suite application, provided that you are logged in as a user with sufficient permissions. From the Navigator menu, select the Integrated SOA Gateway responsibility, then click the Integration Repository link that appears.
Oracle E-Business Suite Integrated SOA Gateway allows the following three roles to access the Integration Repository user interfaces and perform necessary tasks:
System Integration Analyst
System Integration Developer
Integration Repository Administrator
Users granted with different roles can perform various tasks as described in the following table:
| Privileges | System Integration Analyst | System Integration Developer | Integration Repository Administrator |
|---|---|---|---|
| View Public Interfaces | Yes | Yes | Yes |
| View Private/Internal Interfaces | No | Yes | Yes |
| Generate/Regenerate Web Services (WSDL) | No | No | Yes |
| Deploy/Redeploy Web Services | No | No | Yes |
| Undeploy Web Services | No | No | Yes |
| Subscribe to Business Events | No | No | Yes |
| Create Grants | No | No | Yes |
| Download Composite Service | No (Configurable) | Yes | Yes |
Note: Oracle E-Business Suite Integrated SOA Gateway leverages the concepts of permissions and permission sets to grant appropriate access privileges or permissions to users through roles. For example, multiple privileges related to administrative functions can be grouped into an administrative permission set and then granted to an appropriate user through the Integration Repository Administrator role. That user becomes an integration repository administrator and has privileges to perform administrative tasks.
System integration analysts by default do not have the privilege to download composite services unless they are granted with the Download Composite Service privilege through a permission set. For more information on how to manage security through roles, see Role-Based Access Control (RBAC) Security, Oracle E-Business Suite Integrated SOA Gateway Implementation Guide.
Users with the Integration Repository Administrator role can find the Administration link from the Navigator menu after logging on with the Integrated SOA Gateway responsibility. This Administration link contains the following two links allowing you to perform additional administrative functions outside the Integration Repository user interface:
SOA Monitor: This link allows the administrators to access the SOA Monitor user interface where the administrators can monitor and audit all SOAP messages in and out through SOA Provider and view the message details.
For information about how to use SOA Monitor, see Monitoring and Managing SOAP Messages Using SOA Monitor, Oracle E-Business Suite Integrated SOA Gateway Implementation Guide.
Log: This link allows the administrators to access the centralized Log configuration user interface where the administrators can enable and configure log setups.
For information about log configuration, see Logging for Web Services, Oracle E-Business Suite Integrated SOA Gateway Implementation Guide.
For detailed information on each task performed by the Integration Repository Administrator role, see Oracle E-Business Suite Integrated SOA Gateway Implementation Guide. For tasks related to the System Integration Developer role, see Oracle E-Business Suite Integrated SOA Gateway Developer's Guide.
Oracle Integration Repository has two main user interfaces: The Browse interface (the default) and the Search interface.
Following are links to some of the commonly requested information about using Oracle Integration Repository:
The Browse interface appears by default when you invoke Oracle Integration Repository. You can also access it by clicking the Browse button on the search page or any interface information page.
You can browse directly to an appropriate list of interfaces if you know which product family and product you want to integrate with, plus one of the following:
Business entity
Business entities are objects that either perform business activities or have business activities performed on them. Sales orders, employees, purchase orders, customers, and receipts are all examples of business entities. An interface can be used by multiple business entities, and a business entity can be accessed using multiple interfaces.
Interface type
Business interface information in Oracle Integration Repository is organized for browsing and searching by interface type, based on the integration technology used.
For more information, see Interface Types.
Integration standard
XML Gateway and Web service-based interfaces conform to various industry standards.
For more information, see Integration Standards.
If you don't have this information, you'll find it more effective to conduct a search.
Oracle Integration Repository Browse Page
You browse the interfaces by selecting one of the following views from the View By list:
Product Family
Interface Type
Standard (integration standard)
Expand the navigation tree in one of these views to see a list of the available interfaces. To save the list of interfaces in a CSV file, click Export.
To review the details of an interface, click the interface name on the list.
The Product Family view is organized as follows: Product Family > Product > Business Entity.
For example, Financials > Payables > Payables Invoice.
Select a business entity to view the interfaces that comprise it. Note that a business entity can include multiple interfaces of different types owned by different products. For example, the business entity "Payables Invoice" includes the following:
Create Credit Card Issue Invoice open interface from Internet Expenses
Invoice open interface from Payables
Invoice Notification XML Message from Supply Chain Trading Connector
The Interface Type view is organized as follows: Interface Type > Product Family > Product.
For example, Web Service > Financials > Cash Management.
Use this view to see all of the interfaces available for a particular product that use a particular interface type.
The Standard view is organized as follows: Standard and Version > Product Family > Product.
For example, OAG7.2 > Financials > Payables > Process Invoice.
Use this view to browse for a product's XML Gateway maps and Web services belonging to the specified standard, for example W3C or OAG 7.2.
Click the Search button anywhere in Oracle Integration Repository to access the main Search page.
Oracle Integration Repository Search Page
You can search for interfaces with any combination of the following criteria:
Note: Before entering search criteria in the Search page, you will find the default value 'All' automatically displayed in the Product Family, Product, Interface Source, and Interface Type fields. This allows a search to be executed appropriately if you do not make further selections from the drop-down lists.
Additionally, the same default value 'All' can also be found in the Category, Status, Web Service Status, Standard, and Scope fields while clicking the Show More Search Options link.
Interface Name
Product Family
Product
Click Show More Search Options to include any of the following additional criteria in your search:
Category and Category Value
Used to qualify product-specific features or to categorize a subtype of an interface. You can select one of the following available category drop-down values if needed:
All (default) - This displays all integration interfaces regardless of category and category values.
Extensions - This category indicates that specific methods of extending the API functionality are provided by certain products. Examples of extensions are the User Hooks provided by Human Resource Management System and Client Extensions provided by Projects.
When Extensions category is selected, you can select the category value (for example, HRMS User Hooks provided).
Interface Subtype - This category indicates that a subtype of an interface is available.
For example, 'Java APIs for Forms' is a subtype of Java interface.
When Interface Subtype category is selected, the Java APIs for Forms is automatically selected as the Category Value.
Select one of the following values from the drop-down list:
All (default) - All integration interfaces will be displayed from the search.
Oracle - All Oracle native packaged integration interfaces and services are categorized with this interface source type.
Custom - This indicates annotated custom integration interfaces. Custom integration interfaces are displayed along with Oracle interfaces from the browser tree.
Status
Select one of the following values from the drop-down list:
All (default)
Active
Deprecated
Obsolete
Planned
For more information, see Status in the Common Information table.
Web Service Status
If an integration interface is exposed or generated as a Web service, then the Web service can be further deployed from Oracle Integration Repository to the application server.
Use the Web Service Status field to search by different stages of Web services during the service generation and deployment life cycle.
Select one of the following values from the drop-down list:
All (default) - This displays all interfaces regardless of the interface types whether they are service enabled or not.
Not Generated - This displays all service-enabled interfaces that do not have Web service generated.
Generated - This displays all interfaces that have Web services generated, but have not yet been deployed.
Deployed - This displays all interfaces that have Web services generated and deployed.
For more information, see Common Information on Web Services.
Scope
Select one of the following values from the drop-down list:
All (default) - All integration interfaces regardless of public, internal, or private interfaces.
Public - These interfaces can be used by anyone.
Internal To Oracle - These interfaces are available for business integration between applications within Oracle E-Business Suite.
For example, if an interface of this type (Internal to Oracle) belongs to Application Object Library, then that interface can be used by any other applications within Oracle E-Business Suite for process integration in addition to using by the Application Object Library.
This type of interface can only be accessed by users with the integration developer role and the integration repository administrator role.
Private To Application - These interfaces are available for business integration only within the application itself. They will not be used by any other applications outside the application that the interface belongs to.
For example, if an interface with this 'Private to Application' type belongs to Purchasing application, then it will not be used by any other applications within Oracle E-Business Suite but Purchasing.
This type of interface can only be accessed by users with the integration developer role and the integration repository administrator role.
Standard and Standard Specification
For more information, see Integration Standards.
After selecting your criteria, click Go to launch the search and see a list of the available interfaces that meet the criteria. To save the list of interfaces to a CSV file, click Export.
To review the details of an interface, click the interface name on the list.
Business interfaces are organized into interface types according to the integration technologies on which they're based.
Based on the natural way of how services are formed or established, Oracle Integration Repository supports the following interface types:
Native Services
Native services are native packaged integration interfaces. This type of service includes the following native interfaces:
PL/SQL
XML Gateway
Concurrent Programs
Business Events
Open Interface Tables/Views
EDI
Business Service Object (Service Beans)
Java APIs for Forms
Note: Java APIs for Forms are XML document-based integration points wrapped in Java classes for executing business logic in Oracle Forms. These specialized Java classes are categorized as a subtype of Java interface.
Composite Services
Building upon native services, a composite service consists of a collection of native services that belong to a specific product or product family available in the Integration Repository.
The only available composite service type in this release is Composite - BPEL.
Note: Oracle Integration Repository supports custom integration interfaces that are created and annotated based on Integration Repository annotation standards. After appropriate validation, these annotated source files can be uploaded and displayed along with Oracle interfaces through the Integration Repository browser tree based on the interface types they belong to.
To easily differentiate them from Oracle interfaces, all custom integration interfaces are categorized with interface source 'Custom' while Oracle interfaces are marked with interface source 'Oracle'. For more information about custom integration interfaces and services, see Working With Custom Integration Interfaces and Services.
A business event is an occurrence in an internet application that might be significant to other objects in a system or to external agents. An example of a business event can be the creation of a new sales order or changes to an existing order.
Oracle Workflow uses the Business Event System that leverages the Oracle Advanced Queuing (AQ) infrastructure to communicate and manage business events between systems. The Business Event System consists of an Event Manager and workflow process event activities. The Event Manager lets you register subscriptions to significant events; event activities representing business events within workflow processes let you model complex business flows or logics within workflow processes.
When a local event occurs, the subscribing code is executed in the same transaction as the code that raised the event. Subscription processing can include executing custom code on the event information, sending event information to a workflow process, and sending event information to other queues or systems.
Note: Users with Integration Repository Administrator role can have the privilege to subscribe to a business event in the Business Event Details page. See Oracle E-Business Suite Integrated SOA Gateway Implementation Guide for details.
For more business event information, see Events, Oracle Workflow Developer's Guide.
Oracle XML Gateway comprises a set of services that allows easy integration with Oracle E-Business Suite to support XML messaging. The Oracle E-Business Suite utilizes the Oracle Workflow Business Event System to support event-based XML message creation and consumption.
Oracle XML Gateway consumes events raised by the Oracle E-Business Suite and subscribes to inbound events for processing. XML Gateway uses the message propagation feature of Oracle Advanced Queuing to integrate with Oracle Transport Agent to deliver messages to and receive messages from business partners. XML Gateway supports both Business-to-Business (B2B) and Application-to-Application (A2A) initiatives. XML Gateway message maps (or just XML Gateway maps) can be used directly, or they can be exposed as Web services.
Note: The message map is a file of type .xgm and is created using the XML Gateway Message Designer. Message maps define the data source and data target, any hierarchies between the source and the target, and actions for data transformation and process control.
For the Integration Repository information provided about XML Gateway maps, see XML Gateway Map Information.
For more information about XML Gateway, see Oracle XML Gateway User's Guide.
A business interface can be based on a PL/SQL package from which you invoke procedures and functions appropriate to a narrowly defined integration goal.
For the Integration Repository information provided about PL/SQL, see PL/SQL Information.
In Oracle E-Business Suite, concurrent processing simultaneously executes programs running in the background with online operations to fully utilize your hardware capacity. A concurrent program runs as a concurrent process and is executed by the Concurrent Manager. Functions performed by concurrent programs are typically data-intensive and long-running, such as posting a journal, populating an interface table, and generating an EDI flat file.
For the Integration Repository information provided about Concurrent programs, see Concurrent Program Information. For more information about concurrent programs, refer to the Oracle E-Business Suite System Administrator’s Guide - Configuration.
An open interface consists of the interface tables to store data from external sources and concurrent programs, to validate and apply this data into the Oracle E-Business Suite base tables. All open interfaces are implemented using concurrent programs.
For the Integration Repository information provided about open interface tables, see Open Interface Information.
Interface views are database objects that make data from Oracle E-Business Suite products available for selection and use by destination applications.
For the Integration Repository information provided about interface views, see Interface View Information.
Electronic Data Interchange (EDI) is one form of electronic commerce. Interface data files are electronically exchanged between trading partners as messages in a standard format to minimize manual effort, speed data processing, and ensure accuracy. EDI message transactions are supported by Oracle e-Commerce Gateway.
Oracle e-Commerce Gateway provides users the ability to conduct business electronically between trading partners based on Electronic Commerce standards and methodology. It is designed with an open and flexible architecture for easy integration with trading partners or EDI translators. When used for EDI solutions, e-Commerce Gateway integrates with EDI translators to provide specific EDI standard formats and versions. Oracle e-Commerce Gateway is a file-based integration layer between Oracle E-Business Suite and any other external application.
For the Integration Repository information provided about EDI messages, see EDI Message Information.
For more information about Oracle e-Commerce Gateway, see Oracle e-Commerce Gateway User's Guide.
A business interface can be based on a Java class from which you invoke methods that are appropriate to a narrowly defined integration goal.
Java APIs for Forms
Java APIs for Forms, a subtype of the Java interface, are XML document-based integration interfaces that are wrapped in Java classes for executing business logic in Oracle Forms. These specialized Java classes can be service enabled through SOA Provider.
For the Integration Repository information provided about Java, see Java Information.
A business service object, formerly known as Service Bean, is a high-level service component that allows OA Framework or BC4J components to be deployed as Web services.
It is the tool by which Oracle E-Business Suite employs service oriented architecture (SOA) and Web services to facilitate integration with each other and with third party trading partners.
Business service object interfaces provide access to SOA services to facilitate integration between Oracle E-Business Suite and trading partners. They often employ service data objects as parameters to pass complex data.
Note: A service data object is not actually an interface type; rather, it is an object used by one or more business service objects or other service data objects to pass data. Oracle Integration Repository includes it on lists of interface types, so you can browse or search for business service object interface based on the service data objects that they use.
To enhance the robust integrations between Oracle E-Business Suite, packaged applications, and legacy systems, all interface types stored in the Integration Repository can be exposed as Web services, which are defined with Web Services Description Language (WSDL) content appropriate to the interface types.
Note: Although a Web service does not by itself constitute a business interface, Oracle Integration Repository includes it on lists of interface types, so you can browse or search for the interface types based on the Web services that expose them.
For more information about Web services, see Understanding Web Services.
A composite service consists of a collection of native packaged public interfaces or called native services that belong to a specific product or product family and are available in the Integration Repository.
Composite services use the native service as building blocks to construct the sequence of business flows. Basically, this interface type orchestrates the invocation sequence of discrete Web services into a meaningful end-to-end business process through a Web service composition language BPEL (business process execution language). For example, use Oracle BPEL Process Manager (BPEL PM) to integrate the Order-to-Receipt business process that contains sales order entry, item availability check, pack and ship, and invoice to Accounts Receivable sub processes handled by various applications. This approach effectively tightens up the control of each individual process and makes the entire business flow more efficiently.
Note: Since composite services can be designed and created in Oracle JDeveloper and Oracle Eclipse, based on the different creation methods, composite services can have various composite types such as BPEL, ESB (enterprise service bus), or SCA (service component architecture) types. BPEL and ESB are the typical composite interface types designed using Oracle JDeveloper. However, composite service - BPEL is the only composite service type supported in this release.
For more information about composite services, see Working with Composite Services.
Each Web service interface conforms to an integration standard, for example OAGIS or RosettaNet. The fully qualified standard includes the name, version, and specification. For example: OAG 7.2 CONFIRMBOD_004. The following standards are observed in Oracle Integration Repository:
IFX1.2
OAG6.2
OAG7.0
OAG7.1
OAG7.2
RosettaNet01.01.00
RosettaNet01.03.00
RosettaNet02.02.00
RosettaNet02.03.00
UCCnet2.4
W3C
Copyright © 2005, 2010, Oracle and/or its affiliates. All rights reserved.