3 Configuring the Oracle API Manager Domain

This chapter describes how to create and configure the WebLogic Server domain for Oracle API Manager.

By the end of this chapter, you would have created database schemas for Oracle API Manager and configured an Oracle WebLogic domain with one cluster and two managed servers on a single host.

The following topics are covered:

3.1 Creating the Database Schemas

Before you can configure an Oracle API Manager domain, you must install the required schemas on a database certified for use with this release of Oracle API Manager.

Follow the instructions in this section to install these schemas:

3.1.1 Installing and Configuring a Certified Database

Make sure you have installed and configured a certified database, and that the database is up and running.

For more information, see "Installing a Database and Database Schemas" in Planning an Installation of Oracle Fusion Middleware.

3.1.2 Starting the Repository Creation Utility (RCU)

To start the Repository Creation Utility (RCU):

  1. Navigate to the ORACLE_HOME/oracle_common/bin directory on your system.
  2. Start RCU:

    On UNIX operating systems:

    ./rcu
    

    On Microsoft Windows operating systems:

    rcu.bat
    

3.1.3 Navigating the RCU Screens to Create the Schemas

Follow the instructions in this section to create the schema for Oracle API Manager:

3.1.3.1 Introducing RCU

Click Next.

3.1.3.2 Selecting a Method of Schema Creation

If you have the necessary permission and privileges to perform DBA activities on your database, select System Load and Product Load. This procedure assumes that you have the necessary privileges.

If you do not have the necessary permission or privileges to perform DBA activities in the database, you must select Prepare Scripts for System Load on this screen. This option will generate an SQL script, which can be provided to your database administrator. See "Understanding System Load and Product Load" in Creating Schemas with the Repository Creation Utility.

3.1.3.3 Providing Database Credentials

Provide the database connection details for RCU to connect to your database. You must provide the following information:

  • Database Type

  • Host Name

  • Port

  • Service Name

  • Username

  • Password

  • Role

Click Next to proceed, then click OK on the dialog window confirming that connection to the database was successful.

3.1.3.4 Specifying a Custom Prefix and Selecting Schemas

Select Create new prefix, specify a custom prefix, then select the SOA Suite schema. This will automatically select SOA Infrastructure, along with the following schemas as dependencies:

  • Metadata Services

  • Audit Services

  • Audit Services Append

  • Audit Services Viewer

  • Oracle Platform Security Services

  • User Messaging Service

  • WebLogic Services

A schema called Common Infrastructure Services is also automatically created; this schema is grayed out and cannot be selected or deselected. This schema enables you to retrieve information from RCU during domain configuration. For more information, see "Understanding the Service Table Schema" in Creating Schemas with the Repository Creation Utility.

The custom prefix is used to logically group these schemas together for use in this domain only; you must create a unique set of schemas for each domain as schema sharing across domains is not supported.

Tip:

For more information about custom prefixes, see "Understanding Custom Prefixes" in Creating Schemas with the Repository Creation Utility.

For more information about how to organize your schemas in a multi-domain environment, see "Planning Your Schema Creation" in Creating Schemas with the Repository Creation Utility.

Tip:

You must make a note of the custom prefix you choose to enter here; you will need this later on during the domain creation process.

Click Next to proceed, then click OK on the dialog window confirming that prerequisite checking for schema creation was successful.

3.1.3.5 Specifying Schema Passwords

Specify how you want to set the schema passwords on your database, then specify and confirm your passwords.

Tip:

You must make a note of the passwords you set on this screen; you will need them later on during the domain creation process.

3.1.3.6 Completing Schema Creation

Navigate through the remainder of the RCU screens to complete schema creation. When you reach the Completion Summary screen, click Close to dismiss RCU.

For more information about RCU and its features and concepts, see Creating Schemas with the Repository Creation Utility

3.2 Configuring Your WebLogic Domain

This section provides instructions for creating a WebLogic domain using the configuration wizard.

For more information on other methods available for domain creation, see "Additional Tools for Creating, Extending, and Managing WebLogic Domains" in Creating WebLogic Domains Using the Configuration Wizard.

The following topics are covered in this section:

3.2.1 Starting the Configuration Wizard

To begin domain configuration, navigate to the ORACLE_HOME/oracle_common/common/bin directory and start the WebLogic Server Configuration Wizard.

On UNIX operating systems:

./config.sh

On Microsoft Windows operating systems:

config.cmd

On Windows operating systems, you can also start the Configuration Wizard from the Start menu by selecting All Programs, then selecting Oracle, then selecting OracleHome, then selecting WebLogic Server 12c (12.1.3), then selecting Tools, then selecting Configuration Wizard.

3.2.2 Navigating the Configuration Wizard Screens to Configure the Domain

Follow the instructions in this section to create and configure the domain.

Note:

Extending an existing Service Bus domain with an API Manager domain is not supported in this release. You must create a new domain using the API Manager domain configuration template (which also deploys Service Bus) as described in this section.

3.2.2.1 Selecting the Domain Type and Domain Home Location

On the Configuration Type screen, select Create a New Domain.

In the Domain Location field, specify your Domain home directory.

Oracle recommends that you locate your Domain home in accordance with the directory structure summarized in "What are the Key Oracle Fusion Middleware Directories?" in Understanding Oracle Fusion Middleware, where the Domain home is located outside the Oracle home directory. This directory structure will help you avoid issues when you need to upgrade or reinstall your software.

Tip:

For more information about the Domain home directory, see "Choosing a Domain Home" in Planning an Installation of Oracle Fusion Middleware.

For more information about the other options on this screen, see "Configuration Type" in Creating WebLogic Domains Using the Configuration Wizard.

3.2.2.2 Selecting the Configuration Templates

On the Templates screen, make sure Create Domain Using Product Templates is selected, then select the following templates:

  • Oracle API Manager - 12.2.1. [osb]

    Selecting this template also selects the following dependencies:

    • Basic WebLogic Server Domain - 12.2.1. [wlserver]

    • Oracle Service Bus - 12.2.1 [osb]

    • WebLogic Advanced Web Services for JAX-PRC Extension - 12.2.1 [wlserver]

    • ODSI XQuery 2004 Components - 12.2.1 - [oracle_common]

    • Oracle Enterprise Manager - 12.2.1 [em]

    • Oracle WSM Policy Manager - [oracle_common]

    • Oracle JRF - 12.2.1 [oracle_common]

    • WebLogic Coherence Cluster Extension - 12.2.1 [wlserver]

Tip:

For more information about the options on this screen, see "Templates" in Creating WebLogic Domains Using the Configuration Wizard.

3.2.2.3 Selecting the Application Home Location

On the Application Location screen, select the location where you want to store your applications associated with your domain. This location is also referred to as the Application home directory.

Oracle recommends that you locate your Application home in accordance with the directory structure summarized in "What are the Key Oracle Fusion Middleware Directories?" in Understanding Oracle Fusion Middleware, where the Application home is located outside the Oracle home directory. This directory structure will help you avoid issues when you need to upgrade or reinstall your software.

Tip:

For more information about the Application home directory, see "Choosing an Application Home" in Planning an Installation of Oracle Fusion Middleware.

For more information about the options on this screen, see "Application Location" in Creating WebLogic Domains Using the Configuration Wizard.

3.2.2.4 Configuring the Administrator Account

On the Administrator Account screen, specify the user name and password for the default WebLogic Administrator account for the domain.

Oracle recommends that you make a note of the user name and password specified on this screen; you will need these credentials later to boot and connect to the domain's Administration Server.

3.2.2.5 Specifying the Domain Mode and JDK

On the Domain Mode and JDK screen:

  • Select Production in the Domain Mode field.

  • Select the Oracle Hotspot JDK in the JDK field.

Selecting Production Mode on this screen gives your environment a higher degree of security, requiring a user name and password to deploy applications and to start the Administration Server.

Tip:

More information about the options on this screen, including the differences between development mode and production mode, can be found in Domain Mode and JDK in Creating WebLogic Domains Using the Configuration Wizard.

In production mode, a boot identity file can be created to bypass the need to provide a user name and password when starting the Administration Server. For more information, see "Creating a Boot Identity File for an Administration Server" in Administering Server Startup and Shutdown for Oracle WebLogic Server.

3.2.2.6 Specifying the Database Configuration Type

Select RCU Data to activate the fields on this screen. The RCU Data option instructs the Configuration Wizard to connect to the database and Service Table (STB) schema to automatically retrieve schema information for the schemas needed to configure the domain.

Note:

If you choose to select Manual Configuration on this screen, you will have to manually fill in the parameters for your schema on the JDBC Component Schema screen.

After selecting RCU Data, fill in the following fields:

Field Description

DBMS/Service

Enter the database DBMS name, or service name if you selected a service type driver.

Host Name

Enter the name of the server hosting the database.

Port

Enter the port number on which the database listens.

Schema Owner

Schema Password

Enter the user name and password for connecting to the database's Service Table schema. This is the schema user name and password that was specified for the Service Table component on the "Schema Passwords" screen in RCU (see Creating the Database Schemas).

The default user name is prefix_STB, where prefix is the custom prefix that you defined in RCU.

Click Get RCU Configuration when you are finished specifying the database connection information. The following output in the Connection Result Log indicates that the operating succeeded:

Connecting to the database server...OK
Retrieving schema data from database server...OK
Binding local schema components with retrieved data...OK

Successfully Done.

Tip:

More information about the RCU Data option can be found in "Understanding the Service Table Schema" in Creating Schemas with the Repository Creation Utility.

More information about the other options on this screen can be found in Datasource Defaults in Creating WebLogic Domains Using the Configuration Wizard

3.2.2.7 Specifying JDBC Component Schema Information

The JDBC component schemas associated with the products for which you are creating the domain are listed in the lower half of the screen.

Select the schemas for which you want to specify data source settings by selecting the check box adjacent to each schema name.

Fill in each field at the top of the screen with information for the database schema you created in Creating the Database Schemas.

Field Description

Vendor

Select the database vendor.

Driver

Select the JDBC driver to use to connect to the database. The list includes common JDBC drivers for the selected database vendor.

DBMS/Service

Enter a database DBMS name, or service name if you selected a service type driver.

Host Name

Enter the name of the server hosting the database.

Port

Enter the port number to be used to connect to the server that hosts the database.

Schema Owner

Enter the user name for connecting to the database's Oracle API Manager schema. This is the schema user name that was specified on the "Schema Passwords" screen in RCU (see Creating the Database Schemas).

The default user name is prefix_STB, where prefix is the custom prefix that you defined in RCU.

Schema Password

Enter the password for connecting to the database's schema. This is the password that was specified for the Service Table component on the "Schema Passwords" screen in RCU (see Creating the Database Schemas).

Tip:

More information about the other options on this screen can be found in JDBC Component Schema in Creating WebLogic Domains Using the Configuration Wizard.

3.2.2.8 Testing the JDBC Connections

Verify that the values on the JDBC Component Schema screen are correct for all schemas. If you selected RCU Data on the previous screen, the schema table should already be populated appropriately.

Tip:

More information about the other options on this screen can be found in Test Component Schema in Creating WebLogic Domains Using the Configuration Wizard

3.2.2.9 Configuring the Keystore

In a default API Manager configuration, you do not have to configure anything on the Keystore screen. Click Next.

Tip:

More information about the options on this screen can be found in Keystore in Creating WebLogic Domains Using the Configuration Wizard.

3.2.2.10 Selecting Advanced Configuration

To complete domain configuration for the topology, select the following options on the Advanced Configuration screen:

  • Administration Server

    This is required to properly configure the listen address of the Administration Server.

  • Node Manager

    This is required to configure Node Manager.

  • Managed Server, Clusters and Coherence

    This is required to configure the Oracle API Manager Managed Server.

3.2.2.11 Configuring the Administration Server Listen Address

On the Administration Server screen, select the drop-down list next to Listen Address and select the IP address on the host where the Administration Server will reside. Do not use "All Local Addresses."

Do not specify any server groups for the Administration Server.

3.2.2.12 Configuring the Node Manager

The Node Manager screen can be used to select the type of Node Manager you want to configure, along with the Node Manager credentials.

Select Per Domain Default Location as the Node Manager type, then specify the Node Manager credentials.

Tip:

For more information about the options on this screen, see "Node Manager" in Creating WebLogic Domains Using the Configuration Wizard.

For more information about the types of Node Manager, see "Node Manager Overview" in Administering Node Manager for Oracle WebLogic Server.

3.2.2.13 Configuring Managed Servers

On the Managed Servers screen, a new Managed Server named osb_server1 is created:

  1. In the Listen Address drop-down list, select the IP address of the host on which the Managed Server will reside. Do not use All Local Addresses. Verify that OSB-MGD-SVRS-COMBINED is selected in the Server Group.

    If you want to have OWSMPM in a different server from the Service Bus server, select OSB-MGD-SVRS-ONLY. This targets only Service Bus but not OWSMPM to the server.

  2. Click Add and repeat this process to create a second Managed Server named osb_server2.

    Configuring a second Managed Server is one of the steps needed to configure the standard topology for high availability. If you are not creating a highly available environment, then this step is optional.

    For more information about the high availability standard topology, see "Understanding the Fusion Middleware Standard HA Topology" in High Availability Guide.

These server names will be referenced throughout this document; if you choose different names be sure to replace them as needed.

Tip:

For more information about the options on this screen, see "Managed Servers" in Creating WebLogic Domains Using the Configuration Wizard.

3.2.2.14 Configuring a Cluster

Use the Clusters screen to create a new cluster:

  1. Click Add.
  2. Specify apimgr_cluster1 in the Cluster Name field.
  3. Leave the Cluster Address field blank.

By default, server instances in a cluster communicate with one another using unicast. If you want to change your cluster communications to use multicast, see "Considerations for Choosing Unicast or Multicast" in Administering Clusters for Oracle WebLogic Server.

New clusters can also be created using Fusion Middleware Control. In such cases, cluster communication (unicast or multicast) can be configured when the new cluster is created. For more information, see "Create and configure clusters" in Oracle WebLogic Server Administration Console Online Help.

Tip:

For more information about the options on this screen, see "Clusters" in Creating WebLogic Domains Using the Configuration Wizard.

3.2.2.15 Assigning Managed Servers to the Cluster

Use the Assign Servers to Clusters screen to assign osb_server1 and osb_server2 to the new cluster apimgr_cluster1:

  1. In the Clusters pane, select the cluster to which you want to assign the servers; in this case, apimgr_cluster1.
  2. In the Servers pane, assign osb_server1 to apimgr_cluster1 by doing one of the following:
    • Click once on osb_server1 to select it, then click on the right arrow to move it beneath the selected cluster (apimgr_cluster1) in the Clusters pane.

    • Double-click on osb_server1 to move it beneath the selected cluster (apimgr_cluster1) in the clusters pane.

  3. Repeat to assign osb_server2 to apimgr_cluster1.

Tip:

For more information about the options on this screen, see "Assign Servers to Clusters" in Creating WebLogic Domains Using the Configuration Wizard.

3.2.2.16 Configuring Coherence Clusters

Use the Coherence Clusters screen to configure the Coherence cluster that is automatically added to the domain. Leave the default port number 0 as the Coherence cluster listen port.

Note:

Setting the unicast listen port to 0 creates an offset for the Managed Server port numbers. The offset is 5000, meaning the maximum allowed value that can be assigned to a Managed Server port number is 60535, instead of 65535.

Note:

For Coherence licensing information, see Client Access to Oracle Coherence Clusters in Oracle® Fusion Middleware Licensing Information User Manual.

3.2.2.17 Creating a New Machine

Use the Machines screen to create a new machine in the domain. A machine is required in order for the Node Manager to be able to start and stop the servers.

Tip:

If you plan to create a high availability environment and know the list of machines required for your target topology, you can follow the directions in this section to create all of the machines at this time. For more information, see "Optional Scale Out Procedure" in High Availability Guide.

  1. Click Add to create a new machine.
  2. Specify apimgr_machine1 in the Name field.
  3. In the Node Manager Listen Address field, select the IP address of the machine where the Managed Servers are being configured.

    You must select a specific interface and not "localhost." This allows Coherence cluster addresses to be dynamically calculated.

  4. Verify the port in the Node Manager Listen Port field.

    The port number 5556, shown in this example, may be referenced by other examples in the documentation. Replace this port number with your own port number as needed.

Note:

If you are extending an existing domain, you can assign servers to any existing machine. It is not necessary to create a new machine unless your situation requires it.

Tip:

For more information about the options on this screen, see "Machines" in Creating WebLogic Domains Using the Configuration Wizard.

3.2.2.18 Assigning Servers to Machines

Use the Assign Servers to Machines screen to assign the Administration Server and Managed Servers to the new machine you just created:

  1. In the Machines pane, select the machine to which you want to assign the servers; in this case, apimgr_machine1.
  2. In the Servers pane, assign AdminServer to apimgr_machine1 by doing one of the following:
    • Click once on AdminServer to select it, then click on the right arrow to move it beneath the selected machine (apimgr_machine1) in the Machines pane.

    • Double-click on AdminServer to move it beneath the selected machine (apimgr_machine1) in the Machines pane.

  3. Repeat to assign both osb_server1 and osb_server2 to apimgr_machine1.

Tip:

For more information about the options on this screen, see "Assign Servers to Machines" in Creating WebLogic Domains Using the Configuration Wizard.

3.2.2.19 Reviewing Your Configuration Specifications and Configuring the Domain

The Configuration Summary screen contains the detailed configuration information for the domain you are about to create. Review the details of each item on the screen and verify that the information is correct.

You can go back to any previous screen if you need to make any changes, either by using the Back button or by selecting the screen in the navigation pane.

Domain creation will not begin until you click Create.

Tip:

More information about the options on this screen can be found in Configuration Summary in Creating WebLogic Domains Using the Configuration Wizard.

3.2.2.20 Writing Down Your Domain Home and Administration Server URL

The Configuration Success screen will show the following items about the domain you just configured:

  • Domain Location

  • Administration Server URL

You must make a note of both items as you will need them later; the domain location is needed to access the scripts used to start the Administration Server, and the URL is needed to access the Administration Server.

Click Finish to dismiss the configuration wizard.

3.3 Starting the Servers

This section provides information about tools you can access to manage your domain, after the configuration is complete.

Note:

For more information on additional tools you can use to manage your domain, see "Overview of Oracle Fusion Middleware Administration Tools" in Administering Oracle Fusion Middleware.

3.3.1 Starting the Node Manager

To start your per-domain Node Manager, go to the DOMAIN_HOME/bin directory.

On UNIX operating systems, start the Node Manager as shown below, using nohup and nm.out as an example output file:

nohup ./startNodeManager.sh > $LOG_DIR/nm.out&

In the preceding command, LOG_DIR is the location of directory in which you want to store the log files.

On Windows operating systems, run:

startNodeManager.cmd

Note:

On Windows operating systems, it is recommended that you configure Node Manager to run as a startup service. This allows Node Manager to start up automatically each time the system is restarted.

For more information, see "Running Node Manager as a Startup Service" in Administering Node Manager for Oracle WebLogic Server.

For more information about additional Node Manager configuration options, see Administering Node Manager for Oracle WebLogic Server.

3.3.2 Starting the Administration Server

To start the Administration Server, go the DOMAIN_HOME/bin directory.

On UNIX operating systems, run:

./startWebLogic.sh

On Windows operating systems, run:

startWebLogic.cmd

If you have selected Production Mode on the Domain Mode and JDK screen in Specifying the Domain Mode and JDK, you will be prompted for the login credentials of the Administrator user as provided on the Administrator Account screen in Configuring the Administrator Account.

Tip:

For more information about starting the Administration Server, see "Starting and Stopping Administration Servers" in Administering Oracle Fusion Middleware.

In production mode, a boot identity file can be created to bypass the need to provide a user name and password when starting the Administration Server. For more information, see "Creating a Boot Identity File for an Administration Server" in Administering Server Startup and Shutdown for Oracle WebLogic Server.

You can verify that the Administration Server is up and running by accessing the Administration Server Console. The URL is provided on the Configuration Success screen in Writing Down Your Domain Home and Administration Server URL.

Note:

Make sure that the database hosting your product schemas is up and running and accessible by the Administration Server.

http://administration_server_host:administration_server_port/console

The default Administration Server port number is 7001.

For more information about how to use the Administration Console, see "Getting Started Using Oracle WebLogic Server Administration Console" in Administering Oracle Fusion Middleware.

3.3.3 Starting the Managed Servers

To start the Managed Servers:

  1. Log in to Oracle Fusion Middleware Control:
    http://administration_server_host:administration_server_port/em
    

    The Administration Server host and port number were in the URL on the Configuration Success screen (Writing Down Your Domain Home and Administration Server URL). The default Administration Server port number is 7001.

    The login credentials were provided on the Administrator Account screen (Configuring the Administrator Account).

  2. From the "Target Navigation" pane, click the arrows to expand the domain until the Managed Servers (osb_server1 and osb_server2) are visible.
  3. Select the first Managed Server (osb_server1).
  4. Next to the WebLogic Server menu, select Start Up.
  5. Repeat Steps 3 and 4 to start osb_server2.
  6. In the Target Navigation page, select your domain name to see that all the servers are up and running.

3.4 Next Steps

The next steps include creating users and assigning user roles.

See Managing Users in Oracle API Manager for more information.