Common Information on Interface Details

When you click an interface name link from the Interface List page or the Search Interface page, the interface details page appears where you can view the selected interface information.

For information on SOAP and REST Web services, see Common Information on SOAP Web Services and Common Information on REST Web Services.

The following fields are common to almost all interface types:

Field Notes
Internal Name This is the PL/SQL package name, the document name, or the Java service interface name.

Note: For Java service interfaces, this is called Qualified Name, and includes the full Java package name and the class name.

Type Business interfaces are organized into interface types according to the integration technologies on which they're based.
Examples of interface types supported in Integration Repository are PL/SQL, XML Gateway, Concurrent Programs, Business Events, Open Interface Tables/Views, EDI, Business Service Object (Service Beans), Java, and Composite Service - BPEL.
For more information about interface type, see interface type.
Product An Oracle E-Business Suite application or component that supplies the interface.
Business Entity Business entities are objects that either perform business activities or have business activities performed on them. For example, sales orders, account numbers, employees, purchase orders, customers, and receipts are all business entities. An interface can be used by multiple business entities, and a business entity can be accessed by multiple interfaces.
The Business Entity field lists the business entities accessed by an interface. Click a business entity name to view a list of available interfaces to that entity.
Status Valid status codes are:
  • Active

  • Deprecated - This interface should not be used, but it will be supported until obsolete.

  • Obsolete - The interface is no longer supported.

  • Planned - This interface will be activated at a future date.

Scope The scope can be one of the following:
  • Public

  • Internal To Oracle

  • Private To Application


For more information, see Scope on the Oracle Integration Repository Search page.
Interface Source The interface source can be one of the following:
  • Oracle- All Oracle seeded integration interfaces are categorized with this interface source type.

  • Custom- This indicates the interface is a custom integration interface or service.

My Oracle Support Included for an interface that has a related My Oracle Support (formerly OracleMetaLink) Knowledge Document. Click the link to log on to My Oracle Support with a valid user name and password and view the Knowledge Document.
Documentation Included for an interface that has related online documentation. Click the link to view or download the documentation.
Online Help Provided for an interface that has related Oracle E-Business Suite online help. Click the link to view online help for the interface.

The following table describes each field contained in the Source Information region:

Field Notes
Source File It indicates the source code file for this interface, and its location in the file system.
Source Version It indicates the version of the source file. The first portion of the number corresponds to the base release version of Oracle E-Business Suite; the second portion is the version of the file. For example, 120.8 is Oracle E-Business Suite 12.0, and 8 indicates that this is the 8th version of the file.

Note: The version number changes only when it has been worked on by Oracle development. Therefore the version may increment multiple times between releases, or not at all.

Source Product It represents the product code of the source product. The source product specifies under which product directory the file resides in the Oracle E-Business Suite file system (also referred to as the product top).

Suggestion: This field shows the product shortname. You can learn the corresponding full product name by choosing the System Administration responsibility from the Navigator menu, then selecting Oracle Applications Manager > License Manager > Reports > Licensed Products. On the product list that appears, you can filter the results for any product abbreviation (shortname) or license status.