1 Planning the Installation

This chapter provides information about planning an Oracle API Catalog installation.

This chapter includes the following sections:

1.1 Introducing Oracle API Catalog Installation

Oracle API Catalog includes a simple metamodel for an API asset, automation to populate OAC, and the ability for users to search OAC for APIs and understand the details of the APIs to assess their fit in the users application.

Oracle API Catalog consists of the following subcomponents that can be installed on your system:

  • Core Product: Installs everything necessary for Oracle API Catalog.

  • Oracle API Catalog Plug-ins

    The following plug-ins are available in Oracle API Catalog:

    • Development Environments (IDEs)

      • Oracle JDeveloper

    • Harvester Plug-ins for

      • WLST

      • Ant

Note:

Installing Oracle Enterprise Repository and Oracle API Catalog into the same Middleware Home is not supported. If you create a valid OER or OAC domain in a Middleware Home, and then create a valid domain for the other product in the same Middleware Home, accessing the first domain you created (whether it is OER or OAC) results in a message similar to the following:

The server has not found anything matching the Request-URI

To run Oracle Enterprise Repository and Oracle API Catalog from the same server simultaneously, you must install each into a separate Middleware Home.

1.2 Product Distribution

You must obtain this installer from the Oracle Software Delivery Cloud located at

https://edelivery.oracle.com/

Note:

You must accept the license agreement before you download the installer.

1.3 Verifying Certification, System Requirements, and Interoperability

Oracle recommends that you use the certification matrix and system requirements documents in conjunction with each other to verify that your environment meets the necessary requirements for installation.

Step 1   Verifying Your Environment Meets Certification Requirements

Make sure that you are installing your product on a supported hardware and software configuration. For more information, see the certification document for your release on the Oracle Fusion Middleware Supported System Configurations page.

Oracle has tested and verified the performance of your product on all certified systems and environments; whenever new certifications occur, they are added to the proper certification document right away. New certifications can occur at any time, and for this reason the certification documents are kept outside of the documentation libraries and are available on Oracle Technology Network.

Step 2   Using the System Requirements Document to Verify Certification

Oracle recommends that you use the Oracle Fusion Middleware System Requirements and Specifications document to verify that the requirements of the certification are met. For example, if the certification document indicates that your product is certified for installation on 64-Bit Oracle Linux 5, this document should be used to verify that your Oracle Linux 5 system has met the required minimum specifications, like disk space, available memory, specific platform packages and patches, and other operating system-specific items. System requirements can be updated at any time, and for this reason the system requirement documents are kept outside of the documentation libraries and are available on Oracle Technology Network.

Step 3   Verifying Interoperability Among Multiple Products

The Oracle Fusion Middleware Understanding Interoperability and Compatibility document defines interoperability, defines compatibility, and describes how multiple Fusion Middleware products from the same release or mixed releases may be used with each other. You should read this document if you are planning to install multiple Fusion Middleware products on your system.

1.4 Installing Software Required for an Oracle API Catalog Installation

You must install the components described in this section before installing API Catalog.

This section contains the following:

1.4.1 Installing a Certified JDK

Before you can install Oracle API Catalog, you must download and install a supported JDK on your system before attempting to run the installer.

Make sure that the JDK is installed outside of the Oracle home. The Oracle Universal Installer validates that the designated Oracle home directory is empty, and the install will not progress until an empty directory is specified. If you install JDK under Oracle home, you will experience issues in future operations. So, it is recommended that you use the /home/oracle/products/jdk directory for the location of your JDK installation. You can then use the java -jar command to run the installer JAR file.

At the time this document was published, Oracle Fusion Middleware products required JDK 7.0 Update 55 or later. However, you should always verify the required JDK version by reviewing the certification information, as described in Section 1.3.

To download the required JDK, use your browser to navigate to the following URL and download the Java SE JDK:

http://www.oracle.com/technetwork/java/javase/downloads/index.html

1.4.2 Installing and Configuring a Certified Database

Oracle API Catalog requires database schemas prior to domain configuration. If you do not already have a database where you can install these schemas, you must install and configure a certified database.

To find a certified database for your operating system, see the certification document for your release on the Oracle Fusion Middleware Supported System Configurations page.

To make sure your database is properly configured for schema creation, see "Verifying Requirements for Oracle Repository Creation Utility" in the Oracle Fusion Middleware System Requirements and Specifications document.

Note:

For 12c Release 1 (12.1.3), only a certified Oracle database can be used for the Oracle Fusion Middleware Infrastructure standard installation topology.

When installing or identifying a database to use with Oracle SOA Suite, there are additional considerations, including the size and profile of the database and its ability to store data for large numbers of Oracle SOA Suite composite applications. For more information, see the following resources:

See the following references for more information about creating your product schemas:

Note:

After installing a certified database and installing the product software, you must install the RCU patch as described in Section 2.4.1, "Installing the RCU Patch" before you can create the product schemas.

1.4.3 Installing Oracle Fusion Middleware 12c Infrastructure

After you have installed the JDK and installed and configured a certified database, you must install an Oracle WebLogic Server instance. After installing Oracle API Catalog and creating the required database schemas, you configure a domain and deploy the application to a WebLogic server instance.

The latest version of Oracle WebLogic Server is available by installing the Oracle Fusion Middleware Infrastructure.

Note:

You must install Oracle WebLogic server using the Oracle Fusion Middleware 12c (12.1.3.0.0) Infrastructure installer (Part Number V44416-01) that includes Java Required Files (JRF). JRF consists of components not typically included in WebLogic Server installations that provide common functionality for Oracle business applications and application frameworks.

You must obtain this installer from the Oracle Fusion Middleware 12c Media Pack on the Oracle Software Delivery Cloud located at

https://edelivery.oracle.com/

Installing WebLogic Server using another installer will cause the OAC installation to fail.

For more information about installing and configuring the Oracle Fusion Middleware Infrastructure, see Oracle Fusion Middleware Installing and Configuring the Oracle Fusion Middleware Infrastructure.

1.5 Choosing an Oracle Home Directory

During the installation of the Oracle software, you are prompted to specify an Oracle home directory. This directory serves as a repository for common files that are used by various Oracle products installed on the same computer. For this reason, the Oracle home directory can be considered a central support directory for all the Oracle products installed on your system.

The files in the Oracle home directory are essential to ensuring that Oracle software operates correctly on your system. These files:

  • Facilitate checking of cross-product dependencies during installation

  • Facilitate Service Pack installation

The default Oracle home directory where these files are installed is:

$ORACLE_HOME/oer

All files related to the application installation are found under this Oracle home directory.

For more information about Oracle Fusion Middleware directory structure, see "Selecting Directories for Installation and Configuration" in Oracle Fusion Middleware Planning an Installation of Oracle Fusion Middleware.

1.6 Next Steps

After all of the tasks in this chapter have been addressed, continue to Chapter 2, "Installing the Oracle API Catalog Software" for information about running the Oracle API Catalog installation program.