7 Configuring the Domain for the Standalone Collocated Agent

Create and configure an Oracle Data Integrator (ODI) domain for the standalone collocated agent.

This chapter includes the following sections:

7.1 Creating the Database Schema

Ensure that you have created the required schema in your database for your standalone collocated agent.

Before you can configure the topology for your standalone collocated agent, make sure you have created the necessary schema in your database. See Creating the Master and Work Repository Schemas for instructions.

7.2 Creating a Standalone Agent in the Master Repository Using Oracle Data Integrator Studio

Learn how to create a standalone agent for a topology with Oracle Data Integrator Studio (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.

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 a standalone agent using ODI Studio, see Creating an Agent in the Master Repository with ODI Studio.

7.3 Configuring Your WebLogic Domain for Your Standalone Collocated Agent

Learn how to create a WebLogic domain for your standalone collocated agent with the Configuration Wizard.

For more information on other methods available for domain creation, see Additional Tools for Creating, Extending, and Managing WebLogic Domains.

This topic contains the following tasks:

7.3.1 Starting the Configuration Wizard

The WebLogic Server Configuration Wizard is the tool you use to configure your domain.

To start 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

7.3.2 Navigating the Configuration Wizard Screens to Configure the Domain

Learn how to use the WebLogic Server Configuration Wizard to create a domain.

To create and configure the domain for the topology:

  1. 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, 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.

  2. On the Templates screen, select the Oracle Data Integrator - Standalone Collocated Agent - 12.2.1.1.0 [odi] template.

    Selecting this template automatically selects the following as dependencies:

    • Oracle JRF - 12.2.1.1.0 [oracle_common]

    • Oracle Coherence Cluster Extension - 12.2.1.1.0 [wlserver]

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

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

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

    The default username is prefix_STB, where prefix is the custom prefix that you defined in RCU.
    Description of GUID-6D354AFE-3FEE-482C-A27A-0E2A2A2629BD-default.gif follows
    Description of the illustration GUID-6D354AFE-3FEE-482C-A27A-0E2A2A2629BD-default.gif

    Click Get RCU Configuration. 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 other options on this screen can be found in Datasource Defaults.

  6. 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:

    For high availability environments, see the following sections in 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.

  7. Use the JDBC Component Schema Test screen to test the datasource connections.

    A green check mark in the Status column will appear next to the ODI Master Repository component, indicating a successful test. The template you have selected does not require the other datasource connections in the domain to be tested.

    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.

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

    • System Components

      This is required to configure the standalone agent.

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

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

    More information about the types of Node Manager can be found in Node Manager Overview.

  11. On the System Components screen, specify OracleDIAgent1 in the System Component column as the name of the agent (the name of the Java EE agent created earlier is OracleDIAgent), and make sure ODI is selected in the Component Type column.
  12. On the ODI Server Configuration screen, provide the information as described in the following table.
    Field Value

    System Component

    Make sure OracleDIAgent1 is selected from the drop-down list.

    Server Listen Address

    Enter the host name or IP address of the system on which the agent resides. Do not use "localhost."

    Server Listen Port

    Specify the port number on which this agent will listen.

    Supervisor Username

    Make sure this user name is SUPERVISOR (all CAPS).

    Supervisor Password

    Specify the password for the SUPERVISOR user, as previously configured in the domain.

    Preferred Datasource

    Use the default OdiMasterRepository; do not change this field.

    Note:

    Oracle recommends that you write down the host name and port number of the agent; you will need this later when you create the agent in the master repository (Creating a Standalone Agent in the Master Repository Using Oracle Data Integrator Studio).

    Tip:

    More information about the other options on this screen can be found in ODI Server Configuration.

    Description of GUID-4FDD88A3-83E7-48E1-BA98-BB80751C01E4-default.gif follows
    Description of the illustration GUID-4FDD88A3-83E7-48E1-BA98-BB80751C01E4-default.gif
  13. The system component you just created is automatically assigned to a machine called LocalODIMachine. The Machines screen shows that this machine is already created.

    In the Node Manager Listen Address field, select the IP address of the host running Node Manager. Do not use "localhost".

    Description of GUID-37F5674C-BEE4-4488-ADEE-A198FEEB8D28-default.gif follows
    Description of the illustration GUID-37F5674C-BEE4-4488-ADEE-A198FEEB8D28-default.gif
  14. On the Assign System Components to Machines screen, verify that your system component OracleDIAgent1 is already assigned to the LocalODIMachine.
  15. The Configuration Summary screen contains the detailed configuration information for the domain you are about to update. 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 Update.

    Tip:

    More information about the options on this screen can be found in Configuration Summary.

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

When domain creation is complete, click Finish to dismiss the configuration wizard.

7.4 Adding Additional Libraries to a Standalone or Standalone Collocated Agent

Learn how to add libraries to a standalone or standalone collocated agent.

For information about adding libraries to a Java EE agent, see Adding Additional Libraries to a Java EE Agent.
To add additional libraries to your Oracle Data Integrator (ODI) standalone or standalone collocated agent, do either of the following:

  • Set the environment variable ODI_ADDITIONAL_CLASSPATH pointing to the path locating additional jars before starting the agent, as illustrated in the following example:

    ODI_ADDITIONAL_CLASSPATH=/share/libs/mytool.jar:/share/libs/drivers/mydriver.jar

  • Copy the additional libraries to the <DOMAIN_HOME>/lib directory and the ODI standalone and standalone collocated agents will automatically add these jars to the agent’s classpath.
  • Edit the <DOMAIN_HOME>/config/fmwconfig/components/ODI/<Agent Name>/bin/instance.sh/cmd command to add the JARs/ZIPs/paths to the ODI_POST_CLASSPATH variable.

7.5 Starting a Standalone Collocated Agent with Node Manager

Learn how to start a standalone collocated agent with Node Manager.

Note:

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

To start your standalone collocated agent with Node Manager:

7.5.1 Starting Node Manager

Learn how to start Oracle Node Manager in your domain.

To start Node Manager in a domain, first go to the domain DOMAIN_HOME/bin directory. Then start Node Manager as follows:

On UNIX operating systems, use nohup and nm.out as output file:

nohup ./startNodeManager.sh > nm.out&

On Windows operating systems::

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.

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

7.5.2 Starting the Standalone Collocated Agent

Learn how to start the standalone collocated agent.

To start your standalone agent, first go to the DOMAIN_HOME/bin directory and run the following command:

On UNIX operating systems:

./startComponent.sh OracleDIAgent1

On Windows operating systems:

startComponent.cmd OracleDIAgent1

You will be prompted for the Administrator password for the domain.

To verify that your agent was started, go to the following URL in your browser:

http://examplehost.exampledomain.com:port/oraclediagent

7.6 Starting a Standalone Collocated Agent Without Node Manager

Learn how to start a standalone collocated agent without using Node Manager.

To start your standalone agent without Node Manager, go to the DOMAIN_HOME/bin directory and run the following command:

On UNIX operating systems:

./agent.sh -NAME=OracleDIAgent1

On Windows operating systems:

agent.cmd -NAME=OracleDIAgent1

Enter the -NAME parameter in capital letters; the name of the agent (in this case, OracleDIAgent1) is case-sensitive.

7.7 Performing Next Steps

Learn about domain administration and configuration, and other tasks that prepare your Oracle Data Integrator environment for development.

Performing Basic Administrative Tasks 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.

Performing Additional Domain Configuration Tasks contains additional domain configuration tasks that take advantage of additional Oracle Fusion Middleware products and features.

Preparing Oracle Data Integrator for Development contains common tasks to help prepare your Oracle Data Integrator environment for development.

Preparing Your Environment For High Availability contains important tasks to help prepare your environment to move to a highly available environment.