Click Search in the Welcome to the Oracle Integration Repository page or any interface details page to access the main Search page.
You can search for interfaces with any combination of the following criteria:
Note: Before entering search criteria 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 executed appropriately if you do not make further selections from the drop-down lists.
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.
Interface Name
This is the interface name displayed in the browse tree of the Integration Repository user interface.
This is the interface name used internally. It can be PL/SQL package name, the document name, or the Java service interface name.
Interface definition can be categorized based on the integration technology used, such as PL/SQL or current program related interfaces, when it is displayed or browsed in the repository.
Interface types supported in Oracle Integration Repository are PL/SQL, Current Program, XML Gateway, Open Interface Tables and Views, Business Service Object, Business event, EDI Interface, Java, and Composite services - BPEL.
Note: Java Bean Services, Application Module Services, Java APIs for Forms, and Security Services are a subtype of Java interface.
Product Family
An Oracle E-Business Suite application family that supplies the interface. Examples of product family can be Application Technology, Financials, and Manufacturing.
Product
An Oracle E-Business Suite application or component that supplies the interface. Examples of product can be Payables, Cash Management, and Order Management.
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.
Click Show More Search Options to include any of the following additional criteria in your search:
Category and Category Value
Use these two fields to qualify product-specific features or to categorize a subtype of an interface. 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', 'Java Bean Services', 'Application Module Services', and 'Security Services' are a subtype of Java interface.
When Interface Subtype category is selected, Java Bean Services, Application Module Services, Java APIs for Forms, and Security Services are automatically displayed as the list of values for your selection.
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 by this interface source type.
Custom - This indicates annotated custom integration interfaces that are uploaded and published in the Integration Repository.
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
Use the Web Service Status field to indicate different state of a Web service during the service generation and deployment life cycle. This field is relevant for the interfaces that can be service enabled.
Select one of the following values from the drop-down list:
All (default) - This displays all interfaces regardless of the interface types whether they can be 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 deployed including services with 'Deployed with Active' state and 'Deployed with Retired' state.
For more information, see Common Information on Web Services.
Scope
Select one of the following values from the drop-down list:
All (default) - This displays all integration interfaces regardless of public, internal, or private interfaces.
Public - This displays public integration interfaces that can be used by anyone.
Internal To Oracle - This displays the interfaces that 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.
Only users who have the Integration Developer role or the Integration Administrator role can access to this type of interfaces.
Private To Application - This displays the interfaces that are available for business integration only within the application itself. This type of interfaces can be used only by the applications that the interfaces belong to. For example, if an interface of this type belongs to Purchasing application, then it will not be used by any other applications within Oracle E-Business Suite but Purchasing.
Only users who have the Integration Developer role or the Integration Administrator role can access to this type of interfaces.
Standard and Standard Specification
For more information, see Integration Standards.
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.