5 Configuring the Domain for the Java EE Agent

This chapter describes how to create and configure a Oracle Data Integrator (ODI) domain for the Java EE agent standard installation topology.

The following topics are covered:

5.1 Creating the Database Schema

Before you can configure the topology for your Java EE agent, make sure you have created the necessary schema in your database. See Chapter 3 for instructions.

5.2 Configuring the WebLogic Domain for the Java EE Agent

This section provides instructions for creating a WebLogic domain for your Java EE agent 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:

5.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

5.2.2 Navigating the Configuration Wizard Screens to Configure the Domain

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

Note:

You can use the same procedure described in this section to extend an existing domain. If your needs do not match the instructions given in the procedure, be sure to make your selections accordingly, or refer to the supporting documentation for additional details.

Domain creation and configuration includes the following tasks:

Task 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.

It is recommended that you locate your Domain home in accordance with the directory structure summarized in "Understanding the Recommended Directory Structure" in Oracle Fusion Middleware Planning an Installation of 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:

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

Task 2   Selecting the Configuration Templates

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

  • Oracle Enterprise Manager Plugin for ODI - 12.1.3.0 [em]

    Selecting this template automatically selects the following as dependencies:

    • Oracle Enterprise Manager - 12.1.3.0 [em]

    • Oracle JRF - 12.1.3.0 [oracle_common]

    • WebLogic Coherence Cluster Extension - 12.1.3.0 [wlserver]

  • Oracle Data Integrator - Agent - 12.1.3.0 [odi]

    Selecting this template automatically selects the following as dependencies:

    • Oracle Data Integrator - Agent Libraries - 12.1.3.0 [odi]

    • Oracle Data Integrator SDK Shared Library Template - 12.1.3.0 [odi]

  • Oracle Data Integrator - Console - 12.1.3.0 [odi]

Note:

For information about configuring and managing a secondary topology using the Oracle Data Integrator Console see Appendix C, "Secondary Oracle Data Integrator Topology."

Description of config_templates_jee.gif follows
Description of the illustration config_templates_jee.gif

Tip:

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

Task 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.

It is recommended that you locate your Application home in accordance with the directory structure summarized in "Understanding the Recommended Directory Structure" in Oracle Fusion Middleware Planning an Installation of 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 re-install your software.

Tip:

More information about the Application home directory can be found in "Choosing an Application Home" in Oracle Fusion Middleware Planning an Installation of Oracle Fusion Middleware.

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

Task 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.

It is recommended 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.

Task 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.

Tip:

More information about the options on this screen can be found in Domain Mode and JDK in Creating WebLogic Domains Using the Configuration Wizard.

Task 6   Specifying the Datasource 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 username and password for connecting to the database's Service Table schema. This is the schema username and password that was specified for the Service Table component on the "Schema Passwords" screen in RCU (see Section 5.1, "Creating the Database Schema").

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

Description of config_db.gif follows
Description of the illustration config_db.gif

Click Get RCU Configuration when you are finished specifying the database connection information. The following output in the Connection Result Log indicates that the operation 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 Oracle Fusion Middleware 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

Task 7   Specifying JDBC Component Schema Information

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. For information about each of the schemas, see Understanding Repository Creation Utility Schemas, IDs, and Tablespaces in Oracle Fusion Middleware Creating Schemas with the Repository Creation Utility.

Tip:

For high availability environments, see the following sections in Oracle Fusion Middleware High Availability Guide for additional information on configuring data sources for Oracle RAC databases:

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

Task 8   Testing the JDBC Connections

Use the JDBC Component Schema Test screen to test the datasource connections you have just configured.

A green check mark in the Status column indicates a successful test. If you encounter any issues, see the error message in the Connection Result Log section of the screen, fix the problem, then try to test the connection again.

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

Task 9   Specifying Supervisor Credentials

Use the Credentials screen to create the following two keys:

  1. A key for the Supervisor user already exists. Modify the credential as follows:

    1. Specify SUPERVISOR (all CAPS) as the user name. This is the default name initially assigned to the Supervisor account and cannot be changed unless you create a new Supervisor account.

    2. The password must be the same password specified on the Custom Variables screen in RCU during schema creation (see Task 6 in Section 3.3).

  2. Create a second credential as follows:

    1. Click the Plus sign (+) icon to add a new credential.

    2. In the Key Name field, enter the name of this domain as the key.

    3. In the Username and Password fields, provide the Administrator user's user name and password.

    4. Select oracle.odi.credmap as the store name.

Description of config_credentials_jee.gif follows
Description of the illustration config_credentials_jee.gif

Task 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 Data Integrator Managed Server.

Task 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.

Task 12   Configuring 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 as the Node Manager type, then specify the Node Manager credentials.

Tip:

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

More information about the types of Node Manager can be found in "Node Manager Overview" in Administering Node Manager for Oracle WebLogic Server.

Task 13   Configuring Managed Servers

On the Managed Servers screen, a new Managed Server named ODI_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."

  2. In the Server Groups drop-down list, select JRF-MAN-SVR. This server group ensures that the Oracle JRF services are targeted to the Managed Servers you are creating.

    Server groups target Fusion Middleware applications and services to one or more servers by mapping defined application service groups to each defined server group. A given application service group may be mapped to multiple server groups if needed. Any application services that are mapped to a given server group are automatically targeted to all servers that are assigned to that group. For more information, see "Application Service Groups, Server Groups, and Application Service Mappings" in Domain Template Reference.

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

Description of config_managed_servers_jee.gif follows
Description of the illustration config_managed_servers_jee.gif

Note:

You must make a note of the IP address and port number for the Managed Server. You will need this information when you configure the ODI agent.

Tip:

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

Task 14   Configuring a Cluster

Use the Clusters screen to create a new cluster:

  1. Click the Add button.

  2. Specify ODI_cluster1 in the Cluster Name field.

  3. Leave the cluster Address field blank.

Description of config_cluster.gif follows
Description of the illustration config_cluster.gif

By default, server instances in a cluster communicate with one another using unicast. If you want to change your cluster communications to use multicast, refer to "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:

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

Task 15   Assigning the Managed Server to the Cluster

Use the Assign Servers to Clusters screen to assign ODI_server1 to the new cluster ODI_cluster1:

  1. In the Clusters pane, select the cluster to which you want to assign the servers; in this case, ODI_cluster1.

  2. In the Servers pane, assign ODI_server1 to ODI_cluster1 by doing one of the following:

    • Click once on ODI_server1 to select it, then click on the right arrow to move it beneath the selected cluster (ODI_cluster1) in the Clusters pane.

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

Description of config_svr_to_clusters_jee.gif follows
Description of the illustration config_svr_to_clusters_jee.gif

Tip:

More information about the options on this screen can be found in Assign Servers to Clusters in Creating WebLogic Domains Using the Configuration Wizard.

Task 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.

See Table 8-2 for more information and next steps for configuring Coherence.

Note:

For Coherence licensing information, refer to "Oracle Coherence" in Licensing Information.

Task 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 Oracle Fusion Middleware High Availability Guide.

  1. Click the Add button to create a new machine.

  2. Specify ODI_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.

Description of config_machines_jee.gif follows
Description of the illustration config_machines_jee.gif

Tip:

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

Task 18   Assigning Servers to Machines

Use the Assign Servers to Machines screen to assign the Administration Server and Managed Server 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, ODI_machine1.

  2. In the Servers pane, assign AdminServer to ODI_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 (ODI_machine1) in the Machines pane.

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

  3. Repeat to assign ODI_server1 to ODI_machine1.

Description of config_svr_to_machines_jee.gif follows
Description of the illustration config_svr_to_machines_jee.gif

Tip:

More information about the options on this screen can be found in Assign Servers to Machines in Creating WebLogic Domains Using the Configuration Wizard.

Task 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.

Task 20   Writing Down Your Domain Home and Administration Server URL

The Configuration Success screen will show the Domain home location and URL of the Administration Server you just configured:

Description of config_success.png follows
Description of the illustration config_success.png

You must make a note of both items as you will need them to start the servers in your domain.

Click Finish to dismiss the configuration wizard.

5.3 Creating a Java EE Agent in the Master Repository Using ODI Studio

A physical agent corresponds to a single standalone agent or a Java EE agent. A physical agent should have a unique name in the topology. The default agent name configured with the installer is OracleDIAgent and the port to be configured for this agent is the managed server port.

As part of its startup sequence, an agent connects to the Master Repository to see if there is a physical agent defined with its name. If it finds its entry, the agent continues with startup and, once started, it reads all the scheduled jobs of itself from the repository and starts processing.

If there is no physical agent entry for an agent, then the agent startup fails.

To create an agent using ODI Studio, see Section 4.5, "Creating an Agent in the Master Repository Using ODI Studio."

5.4 Starting a Java EE Agent

This section describes the procedures for starting the administration server and managed server for a Java EE agent.

Note:

If you have not yet configured the physical agent in the master repository, go to Section 4.5, "Creating an Agent in the Master Repository Using ODI Studio."

This section contains the following topics:

5.4.1 Starting 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 > nm.out&

On Windows operating systems, run:

startNodeManager.cmd

Note:

On Windows operating systems, Oracle recommends configuring 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.

5.4.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 selected Production Mode on the Domain Mode and JDK screen in Task 5, you will be prompted for the login credentials of the Administrator user as provided on the Administrator Account screen in Task 4.

Tip:

For more information about starting the Administration Server, see "Starting and Stopping Administration Servers" in Oracle Fusion Middleware 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 access the Administration Server Console. The URL is provided on the Configuration Success screen in Task 20.

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.

Description of wls_admin_console.gif follows
Description of the illustration wls_admin_console.gif

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

5.4.3 Starting the Managed Server

To start the Managed Server:

  1. Login 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 (Task 20). The default Administration Server port number is 7001.

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

  2. From the "Target Navigation" pane, click the arrows to expand the domain until the Managed Servers (ODI_server1) is visible.

    Description of wls_view_domain.gif follows
    Description of the illustration wls_view_domain.gif

  3. Select the Managed Server (ODI_server1).

  4. Next to the WebLogic Server menu, select Start Up.

    Description of wls_start_server.gif follows
    Description of the illustration wls_start_server.gif

  5. In the Target Navigation page, select your domain name to see that all the servers are up and running.

    Description of wls_servers_running.gif follows
    Description of the illustration wls_servers_running.gif

Tip:

More information about managing Oracle Fusion Middleware using Oracle Enterprise Manager Fusion Middleware Control can be found in Oracle Fusion Middleware Administering Oracle Fusion Middleware with Fusion Middleware Control.

5.5 Performing Next Steps

Section 8.1 contains basic administration tasks. You should familiarize yourself with the tasks described in this section and perform them as needed to verify that your domain is properly configured.

Section 8.2 contains additional domain configuration tasks that take advantage of additional Oracle Fusion Middleware products and features.

Section 8.3 contains common tasks to help prepare your Oracle Data Integrator environment for development.

Section 8.4 contains important tasks to help prepare your environment to move to a highly available environment.