Navigating Through Oracle Integration Repository

This chapter covers the following topics:

Oracle Integration Repository Overview

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 web services and allowing web service clients to make use of the services provided from Oracle E-Business 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 service consumption. Oracle Integration Repository, an integral part of Oracle E-Business Suite, is the repository to serve this purpose.

Oracle Integration Repository contains numerous interface endpoints exposed by applications throughout the entire Oracle E-Business Suite. It is not only an essential component within Oracle E-Business Suite Integrated SOA Gateway, but also provides a complete catalog of integration interfaces within Oracle E-Business Suite. You can use this tool to easily discover and search on interfaces, regardless of custom or Oracle seeded ones.

Integration Interface Types Within Oracle E-Business Suite

Oracle Integration Repository supports various integration interface types categorized as follows:

Detailed information on each interface type, see Interface Types.

Major Features

Getting Started with Oracle Integration Repository

Understanding Oracle E-Business Suite Integrated SOA Gateway User Roles

Oracle E-Business Suite Integrated SOA Gateway allows the following three roles to access the Integration Repository user interfaces and perform necessary tasks. Each user role is associated with a specific responsibility by default to access the Integration Repository.

Users granted different roles can perform various tasks as described in the following table:

Privileges Integration Analyst Integration Developer Integration Administrator
View Public Interfaces Yes Yes Yes
View Private/Internal Interfaces No Yes Yes
Generate/Regenerate SOAP Web Services No Yes Yes
Deploy/Undeploy SOAP Web Services No No Yes
Activate SOAP Web Services No No Yes
Retire SOAP Web Services No No Yes
Reset SOAP Web Services No No Yes
Deploy/Undeploy REST Web Services No No Yes
Subscribe to Business Events No No Yes
Create Grants No No Yes
View Grants No Yes Yes
Delete Custom Interfaces 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 data 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 a user through the Integration Administrator role. That user becomes an integration administrator and has privileges to perform administrative tasks.

Integration analysts by default do not have the privilege to download composite services unless they are granted the download 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.

For information on SOAP and REST web services and how to perform additional administrative tasks, see Common Information on SOAP Web Services and Common Information on REST Web Services.

For information on how to manage security grants, see Managing Grants.

Accessing Oracle Integration Repository

In this release, you can access Oracle Integration Repository through either of the following responsibilities depending on your assigned user role:

Note: There are three predefined user roles used in the Oracle E-Business Suite Integrated SOA Gateway: Integration Analyst, Integration Developer, and Integration Administrator. For more information about these roles, see Understanding Oracle E-Business Suite Integrated SOA Gateway User Roles.

Accessing the Administration Link to Perform Additional Administrative Tasks:

After logging in to Oracle E-Business Suite with the Integrated SOA Gateway responsibility, an integration administrator can find the Administration link, in addition to the Integration Repository link from the Navigator menu.

This Administration link is specifically for the integration administrator to perform additional administrative tasks outside the Integration Repository user interface. Expand the Administration link to display the following links:

For detailed information on each task performed by the users who have the Integration Administrator role, see Oracle E-Business Suite Integrated SOA Gateway Implementation Guide. For tasks related to the users who have the Integration Developer role, see Oracle E-Business Suite Integrated SOA Gateway Developer's Guide.

Using Integration Repository

Integration Repository has the following major user interfaces:

To further understand how to use Oracle Integration Repository, the following topics are included in this section:

Discovering and Reviewing Interfaces

This section includes the following topics:

Browsing the Integration Interfaces

The Browse interface appears by default while accessing the Oracle Integration Repository. You can also access the Browse interface by clicking Browse 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:

Instead of browsing through the integration endpoints from the repository, you can perform a search to locate your desired interfaces or services. See Searching for an Integration Interface.

Oracle Integration Repository Browse Page

the picture is described in the document text

Oracle Integration Repository allows you to browse integration interfaces or services by selecting one of the following views from the View By list:

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 link to access the interface details page.

Browsing by Product Family

The Product Family view is organized as follows: Product Family, then Product, and then Business Entity

For example, Financials, then Payables, and then Payables Invoice.

After selecting a business entity (such as 'Payable Invoice'), click a desired integration interface name link from the Interface List table to view the interface details.

Please note that a business entity can include multiple interfaces of different types owned by different products. For example, the business entity 'Supplier Site' can include the following:

Browsing by Interface Type

The Interface Type view is organized as follows: Interface Type, then Product Family, and then Product.

For example, PL/SQL, then Financials, and then Cash Management.

Use this view to see all of the interfaces available for a particular product that use a particular interface type.

Browsing by Standard

The Standard view is organized as follows: Standard and Version, then Product Family, and then Product.

For example, OAG7.2, then Financials, then Payables, and then Payables 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.

Searching for an Integration Interface

Click Search in the Welcome to the Oracle Integration Repository page or any interface details page to access the main Search page.

Oracle Integration Repository Search Page

the picture is described in the document text

You can search for interfaces with any combination of the following criteria:

Note: In the Search page the default value 'All' is automatically displayed in the Product Family, Product, and Interface Type fields. This allows a search to be processed appropriately if you do not make further changes from the drop-down selections.

Additionally, the same default value 'All' can be found in the Category, Status, Interface Source, Web Service Status, Standard, and Scope fields while clicking the Show More Search Options link.

Click Show More Search Options to include any of the following additional criteria in your search:

Viewing the Search Results

After selecting your criteria, click Go to launch the search. A list of the available interfaces is displayed in the search result table. The interfaces listed in the table are paginated with a maximum of 10 records in one page. If there are more than 10 records retrieved from the search, click the Next icon to view the records listed in the next page.

The search result table lists each interface information including interface name, internal name, product, interface type, source, status, and description. Click the interface name link from the search result table to display the interface details page where you can view the details for the selected interface or service.

To have the search result displayed in your desired order, you can sort the entire set of the search result by clicking the Up Arrow or Down Arrow icon next to the field you want the result to be sorted against. Initially, the result will be sorted by Interface Name in ascending order. You can optionally change the sorting order by clicking on the Down Arrow icon next to the Name field to sort the result in descending order.

To save the list of interfaces to a CSV file, click Export. Click Clear All to clear all the search fields you entered and start a new search if desired.

Interface Details Page

Once an interface is selected from the browsing tree or the search result, the interface details page is displayed. It contains the following two types of information for a given interface:

Integration administrators can perform administrative tasks for a selected interface in this page, such as generating and deploying a web service, subscribing to a business event, and creating security grants.

For more information about this interface details page, see Common Information in Interface Details.

Interface Types

Business interfaces are organized into interface types according to the integration technologies on which they're based.

Based on the natural way of how interfaces are formed or established, Oracle Integration Repository supports the following interface types:

Note: Oracle Integration Repository supports custom integration interfaces that are created and annotated based on Integration Repository annotation standards. After appropriate validation, these annotated custom source files can be uploaded and displayed along with Oracle interfaces through the Integration Repository browser tree, based on the interface types to which they belong.

To easily differentiate custom interfaces from Oracle ones, 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.

PL/SQL Interface

A business interface can be based on a PL/SQL package from which you invoke procedures and functions appropriate to an integration.

PL/SQL APIs are serviceable interfaces and can be exposed as both SOAP-based and REST-based web services.

For more information about PL/SQL interface type in the Integration Repository, see PL/SQL Information.

XML Gateway Message Map

Oracle XML Gateway comprises a set of services that allows easy integration with Oracle E-Business Suite to support XML messaging. Oracle E-Business Suite utilizes Oracle Workflow Business Event System to support event-based XML message creation and consumption.

Oracle XML Gateway consumes events raised by Oracle E-Business Suite and subscribes to inbound events for processing. It 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 message maps can be used directly, or they can be exposed as web services.

Additional Information: 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 more information about XML Gateway map interface type in the Integration Repository, see XML Gateway Map Information.

For more information about Oracle XML Gateway, see the Oracle XML Gateway User's Guide.

Concurrent Program

A concurrent program runs as a concurrent process. That is, it processes multiple programs running in the background. Functions performed by concurrent programs are normally data-intensive and long-running, such as posting a journal, and generating an EDI flat file.

For more information about Concurrent Program interface type in the Integration Repository, see Concurrent Program Information.

For more information about how to use concurrent programs, refer to the Oracle E-Business Suite Setup Guide.

Business Event

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. When a local event occurs, the event subscribing code is processed in the same transaction as the code that raised the event. Subscription processing can include running custom code on the event information, sending event information to a workflow process, and sending event information to other queues or systems.

For more business event information, see Events, Oracle Workflow Developer's Guide.

For more information about business event interface type in the Integration Repository, see Business Event Information.

Open Interface Table

An open interface consists of the interface tables to store data from external sources and concurrent programs, as well as to validate and apply this data into the Oracle E-Business Suite base tables. All open interfaces are implemented using concurrent programs.

Please note that Open Interface Table is often referred as Open Interface.

For more information about Open Interface Table interface type in the Integration Repository, see Open Interface Information.

Open Interface View

Interface views are database objects that make data from Oracle E-Business Suite products available for selection.

For more information about Interface View interface type in the Integration Repository, see Interface View Information.

EDI Message Transaction

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. 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. When used for EDI solutions, Oracle e-Commerce Gateway integrates with EDI translators to provide specific EDI standard formats and versions.

For more information about EDI messages in the Integration Repository, see EDI Message Information.

For more information about Oracle e-Commerce Gateway, see the Oracle e-Commerce Gateway User's Guide.

Business Service Object

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.

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.

For more information about Business Service Object interface type in the Integration Repository, see Business Service Object.

Java

A business interface can be based on a Java class from which you invoke methods that are appropriate to an integration.

Java Bean Services

Java Bean Services are also a subtype of Java interface. This type of Java APIs whose methods must use parameters of either serializable Java Beans or simple data types such as String, Int, and so forth can be categorized as Java Bean Services. Such Java APIs can be exposed as REST services only.

Similar to the PL/SQL REST services, Java Bean Services have simplified development life cycle - Deploy and Undeploy - and are implemented with the same security mechanism. Java Bean Services can be deployed as REST service operations with the POST and GET HTTP methods in this release.

For annotation guidelines on Java Bean Services, see Annotations for Java Bean Services, Oracle E-Business Suite Integrated SOA Gateway Developer's Guide.

Application Module Services

Application Module Implementation class is a Java class that provides access to business logic governing the OA Framework-based components and pages. Such Java classes are called Application Module Services and are categorized as a subtype of Java interface.

Similar to Java Bean Services, Application Module Services can be exposed as REST services only.

For annotation guidelines on Application Module Services, see Annotations for Application Module Services, Oracle E-Business Suite Integrated SOA Gateway Developer's Guide.

Security Services

Security services, built on Java, are a set of predefined and predeployed REST services from Oracle Application Object Library. These services including Authentication and Authorization services are developed for mobile applications.

Security services will not require any REST service lifecycle activities such as Deploy or Undeploy. Additionally, they are available to all users.

For more information about Java interface type in the Integration Repository, see Java Information.

Java APIs for Forms interfaces are not serviceable interfaces and cannot be exposed as SOAP services. Refer to My Oracle Support Knowledge Document 966982.1 for the suggested alternatives to the existing Java APIs for Forms interfaces.

Composite Interfaces

A composite interface consists of a collection of native packaged interfaces or services available in the Integration Repository.

Composite interfaces orchestrate the invocation sequence of web services into an end-to-end business process through a web service composition language BPEL (business process execution language).

Additional Information: Composite interfaces can be designed and created in Oracle JDeveloper and Oracle Eclipse. Based on the creation methods, composite services have various composite types such as BPEL, ESB (enterprise service bus), or SCA (service component architecture) types. Composite - BPEL type is the only supported composite interface in this release.

For more information about composite interfaces, see Working with Composite Interfaces.

Integration Standards

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: