1. Installing and Configuring Oracle Data Integrator
  2. Configuring the Domain for a Standalone Collocated Agent

7 Configuring the Domain for a Standalone Collocated Agent

Create and configure a WebLogic domain for a standalone collocated agent in the standard installation topology.

Creating the Database Schemas

Before you can configure an Oracle Data Integrator domain, you must create the Master and Work Repository (ODI_REPO) schemas on a certified database for use with this release of Oracle Fusion Middleware.

Follow the instructions in Creating the Master and Work Repository Schemas to create the required schemas.

Parent topic: Configuring the Domain for a Standalone Collocated Agent

Creating an Agent in the Master Repository with ODI Studio

A physical agent corresponds to a single standalone agent or a Java EE agent and should have a unique name in the topology. You create an ODI agent in the master repository with ODI Studio.

As part of its startup sequence, an agent connects to the master repository to verify that there is a physical agent defined in the master repositpry 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 them. If it does not find a physical agent entry for an agent, then the startup fails.

Before you can create an ODI agent, you must first start ODI Studio and connected to the master repository in ODI Studio. See:

To create a physical agent in the master repository with ODI Studio:

  1. In the navigation pane on the left side, select the Topology tab, then right-click Agents, then select New Agent.
  2. Specify the new agent details as summarized in the following table:
    Field Description

    Name

    Specify OracleDIAgent1 as the agent name.

    This name must match the system component name.

    Host

    Enter the IP address or name of the machine where the agent is running. Do not use localhost.

    Port

    Enter the port number on which the agent listens.

    Note:

    If your environment includes a cluster with Oracle HTTP Server acting as a front-end to the cluster, provide the host name and port of the Oracle HTTP Server host instead. The name should be OracleDIAgent, not OracleDIAgent1.

  3. From the ODI Studio menu, select File then Save All to save your changes.

Parent topic: Configuring the Domain for a Standalone Collocated Agent

Configuring the Domain

Use the Configuration Wizard to create and configure a domain.

For information on other methods to create domains, see Additional Tools for Creating, Extending, and Managing WebLogic Domains in Creating WebLogic Domains Using the Configuration Wizard.

Parent topic: Configuring the Domain for a Standalone Collocated Agent

Starting the Configuration Wizard

Start the Configuration Wizard to begin configuring a domain.

To start the Configuration Wizard:

  1. Change to the following directory:

    (UNIX) ORACLE_HOME/oracle_common/common/bin

    (Windows) ORACLE_HOME\oracle_common\common\bin

    where ORACLE_HOME is your 12c (12.2.1.4.0) Oracle home.

  2. Enter the following command:

    (UNIX) ./config.sh

    (Windows) config.cmd

Parent topic: Configuring the Domain

Navigating the Configuration Wizard Screens to Create and Configure the Domain

Enter required information in the Configuration Wizard screens to create and configure the domain for the topology.

Note:

You can use this procedure to extend an existing domain. If your needs do not match the instructions in the procedure, be sure to make your selections accordingly, or see the supporting documentation for more details.

Parent topic: Configuring the Domain

Selecting the Domain Type and Domain Home Location

Use the Configuration Type screen to select a Domain home directory location, optimally outside the Oracle home directory.

Oracle recommends that you locate your Domain home in accordance with the directory structure 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 helps avoid issues when you need to upgrade or reinstall software.

To specify the Domain type and Domain home directory:

  1. On the Configuration Type screen, select Create a new domain.
  2. In the Domain Location field, specify your Domain home directory.

For more details about this screen, see Configuration Type in Creating WebLogic Domains Using the Configuration Wizard.

Selecting the Configuration Template

Use the Templates screen to select the templates you require.

On the Templates screen, select the following template:

  • Oracle Data Integrator - Standalone Collocated Agent

    Selecting this template automatically selects the following as dependencies:

    • Oracle JRF

    • Oracle Coherence Cluster Extension

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

Configuring the Administrator Account

Use the Administrator Account screen to 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 that you enter on this screen; you need these credentials later to boot and connect to the domain's Administration Server.

Specifying the Domain Mode and JDK

Use the Domain Mode and JDK screen to specify the domain mode and Java Development Kit (JDK).

On the Domain Mode and JDK screen:

  • Select Production in the Domain Mode field.

  • Select the Oracle HotSpot JDK in the JDK field.

For more information about this screen, see Domain Mode and JDK in Creating WebLogic Domains Using the Configuration Wizard.
Specifying the Database Configuration Type

Use the Database Configuration type screen to specify details about the database and database schema.

On the Database Configuration type screen, select RCU Data. This option instructs the Configuration Wizard to connect to the database and Service Table (STB) schema to automatically retrieve schema information for schemas needed to configure the domain.

Note:

If you select Manual Configuration on this screen, you must manually fill in parameters for your schema on the next screen.

After selecting RCU Data, specify details in the following fields:

Field Description

DBMS/Service

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

Example: orcl.exampledomain.com

Host Name

Enter the name of the server hosting the database.

Example: examplehost.exampledomain.com

Port

Enter the port number on which the database listens.

Example: 1521

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 entered for the Service Table component on the Schema Passwords screen in the RCU (see Specifying Schema Passwords).

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

Click Get RCU Configuration when you finish 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.

For more information about the schema installed when the RCU is run, see About the Service Table Schema in Creating Schemas with the Repository Creation Utility.

See Database Configuration Type in Creating WebLogic Domains Using the Configuration Wizard .

Specifying JDBC Component Schema Information

Use the JDBC Component Schema screen to verify or specify details about the database schemas.

Verify that the values populated 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 high availability environments, see the following sections in High Availability Guide for additional information on configuring data sources for Oracle RAC databases:

See JDBC Component Schema in Creating WebLogic Domains Using the Configuration Wizard for more details about this screen.

Testing the JDBC Connections

Use the JDBC Component Schema Test screen to test the data source connections.

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.

By default, the schema password for each schema component is the password you specified while creating your schemas. If you want different passwords for different schema components, manually edit them in the previous screen (JDBC Component Schema) by entering the password you want in the Schema Password column, against each row. After specifying the passwords, select the check box corresponding to the schemas that you changed the password in and test the connection again.

For more information about this screen, see JDBC Component Schema Test in Creating WebLogic Domains Using the Configuration Wizard.

Selecting Advanced Configuration

Use the Advanced Configuration screen to complete the domain configuration.

On the Advanced Configuration screen, select:

  • Administration Server — Required to properly configure the listen address of the Administration Server.

  • Node Manager — Required to configure Node Manager.

  • System Components — Required to configure the standalone agent.

Optionally, select other available options as required for your desired installation environment. The steps in this guide describe a standard installation topology, but you may choose to follow a different path. If your installation requirements extend to additional options outside the scope of this guide, you may be presented with additional screens to configure those options. For information about all Configuration Wizard screens, see Configuration Wizard Screens in Creating WebLogic Domains Using the Configuration Wizard.

Configuring the Administration Server Listen Address

Use the Administration Server screen to select the IP address of the host.

Select the drop-down list next to Listen Address and select the IP address of the host where the Administration Server will reside, or use the system name or DNS name that maps to a single IP address. Do not use All Local Addresses.

Do not specify any server groups for the Administration Server.

Configuring Node Manager

Use the Node Manager screen 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 Node Manager credentials.

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

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

Creating a New ODI System Component

Use the System Component screen to create a new ODI system component.

On the System Component screen, click Add then:

  1. Under System Component, either accept the default ODI component (OracleDIAgent1) name, or specify a name of your choice.

  2. Under Component Type, ensure that ODI is selected from the drop-down list.

For more information about this screen, see System Components in Creating WebLogic Domains Using the Configuration Wizard.

Configuring the ODI Server Access

Use the ODI Server Configuration screen to configure access to your ODI server.

Set ODI Server configuration values as specified in the following table.

Field Description

System Component

Select the ODI system component (OracleDIAgent1).

Server Listen Address

Specify the IP address of the server where the ODI server should listen. Do not use localhost.

Server Listen Port

Enter the port number on which ODI server listens.

Supervisor Username

Specify SUPERVISOR as the user name.

Supervisor Password

Specify the Supervisor user password, as specified during schema creation.

Preferred Datasource

Use the default OdiMasterRepository; do not change this field.

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

Specifying the Node Manager Host Address

Use the Machines screen to select the IP address of the host running Node Manager.

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.

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

Assigning System Components to Machines

Use the Assign System Components to Machines screen to assign the system component to the ODI machine.

On the Assign System Components to Machines screen, verify that the system component OracleDIAgent1 is assigned to the LocalODIMachine.

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

Reviewing Your Configuration Specifications and Configuring the Domain

The Configuration Summary screen shows detailed configuration information for the domain you are about to create.

Review each item on the screen and verify that the information is correct. To make any changes, go back to a screen by clicking the Back button or selecting the screen in the navigation pane. Domain creation does not start until you click Create.

For more details about options on this screen, see Configuration Summary in Creating WebLogic Domains Using the Configuration Wizard.

Writing Down Your Domain Home and Administration Server URL

The End of Configuration screen shows information about the domain you just configured.

Make a note of the following items because you need them later:

  • Domain Location

  • Administration Server URL

You need the domain location to access scripts that start Node Manager and Administration Server, and you need the URL to access the Administration Server.

Click Finish to dismiss the Configuration Wizard.

Adding Libraries to a Standalone Collocated Agent

After configuring a standalone collocated agent, you can specify additional libraries, if required.

To add libraries to a ODI standalone collocated agent:

  1. Set the environment variable ODI_ADDITIONAL_CLASSPATH to locate additional jars before starting the agent. For example:

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

  2. Do one of the following:

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

Parent topic: Configuring the Domain for a Standalone Collocated Agent

Starting a Standalone Collocated Agent Using Node Manager

Start Node Manager, then start the standalone collated agent.

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.

Parent topic: Configuring the Domain for a Standalone Collocated Agent

Starting Node Manager

To start the per-domain Node Manager:

  1. Change to the following directory:

    • (UNIX) setenv JAVA_HOME /home/Oracle/Java/jdk1.8.0_211

    • (Windows) set JAVA_HOME=C:\home\Oracle\Java\jdk1.8.0_211

  2. Enter the following command:

    • (UNIX) Using nohup and nm.out as an example output file: 

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

      where LOG_DIR is the location of directory in which you want to store the log files.

    • (Windows) startNodeManager.cmd

      Note:

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

      See Running Node Manager as a Startup Service in Administering Node Manager for Oracle WebLogic Server.

Parent topic: Starting a Standalone Collocated Agent Using Node Manager

Starting a Standalone Collocated Agent

To start an ODI standalone collated agent when using Node Manager:

  1. Go to the DOMAIN_HOME/bin directory.

  2. Start the agent:

    • (UNIX) ./startComponent.sh OracleDIAgent1

    • (Windows) startComponent.cmd OracleDIAgent1

  3. At the prompt, enter the Administrator password for the domain.

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

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

Parent topic: Starting a Standalone Collocated Agent Using Node Manager

Starting a Standalone Collocated Agent Without Node Manager

Start a standalone collated agent without Node Manager by using the agent command.

To start a standalone agent without Node Manager:

  1. Go to the DOMAIN_HOME/bin directory.

  2. Start the agent:

    • (UNIX) ./agent.sh -NAME=OracleDIAgent1

    • (Windows) agent.cmd -NAME=OracleDIAgent1

    where -NAME must be entered in all capital letters, and the name of the agent (in this example, OracleDIAgent1) is case-sensitive.

Parent topic: Configuring the Domain for a Standalone Collocated Agent

Verifying the Configuration

After completing all configuration steps, you can perform additional steps to verify that your domain is properly configured.

To verify that the domain is configured properly, see Performing Additional Domain Configuration Tasks.

Note:

If your work repository name is other than the default name WORKREP, you should edit the value of the parameter ODI_SECU_WORK_REP to include the actual work repository name, in the instance.properties file. This additional configuration is required for both standalone agent and standalone collocated agent.

Parent topic: Configuring the Domain for a Standalone Collocated Agent