ODI 12c - Creating a Collocated Agent (2024)

ODI 12c - Creating a Collocated Agent (1)Before You Begin

This tutorial shows you how to use Oracle Data Integrator Studio (ODI Studio) graphical tools to create an agent collocated with WLS to support (among other things) scheduling of procedures. This tutorial takes approximately 20 minutes to complete.

Background

A common task that is performed using ODI is to set up and install an ODI Agent. After the ODI scenarios are created, they can be scheduled and orchestrated using an ODI Agent, which is a lightweight Java process that orchestrates the execution of ODI scenarios. This tutorial walks you through the steps that are needed to set up and install the ODI Agent.

What Do You Need?

Software Requirements

The following is a list of software requirements:

  1. A supported operating system
  2. Oracle Database
  3. Oracle WebLogic Server (WLS) 12c (other versions are supported as well). This OBE requires that WebLogic Server (WLS) is installed. If you do not have WLS installed, see alternate OBE here.
  4. Oracle Data Integrator (ODI) 12c installed as ODI Enterprise
  5. Optional Software - Oracle SQL Developer 12c (included with Database 12c install)

Prerequisites

Before starting this tutorial, you should have:

  • Started Oracle Database services and components such as the Listener.
  • A Database user with DBA role privileges such as the SYS or SYSTEM account.
  • Already installed and configured ODI Master and Work repositories
  • Already created an ODI project and mapping for a flat file to a relational table

ODI 12c - Creating a Collocated Agent (2)Creating the Domain for the Standalone Collocated Agent

The agent in this OBE runs in a domain that is very similar to (but not dependent on) WebLogic Server (WLS) domains. The GUI Configuration Wizard uses templates to determine which components are needed to support the function of the agent. There are three possible kinds of agents:

  • completely standalone agent (no WLS installed)
  • standalone collocated agent (WLS is installed and the agent is started as its own binary. This OBE uses this kind of agent.)
  • JEE agent (WLS installed and used. The domain, admin server, managed servers, node managers, and so on are started in the normal WLS way. The agent is one of many possible JEE apps running in the domain.)

To create the domain for the agent, perform the following steps:

Basic Configuration

  1. Navigate to the /oracle_common/common/bin directory:
  • (UNIX) ORACLE_HOME/oracle_common/common/bin
  • (Windows) ORACLE_HOME\oracle_common\common\bin
  • where ORACLE_HOME is your ODI 12c home directory.

  • Execute the following command to start the Configuration Wizard:
    • (UNIX) ./config.sh
    • (Windows) config.cmd
  • For most of the non-Advanced configuration, the defaults are adequate. On the Configuration Type panel, leave the defaults. Click Next to continue.
  • If you do not yet have a WLS domain, then the first one created will be called base_domain by default. You can rename it to something such as odi_agent or mydomain99, just make sure that it remains in $FMW_HOME/user_projects/domains/. If you already have a domain named base_domain, then you cannot "create" another one. You would have to rename it to base_domain2 or something else, or you could Update an existing domain. The particulars about updating an existing domain are outside the scope of this OBE, and are covered in the WLS curriculum.

  • On the Templates panel, select Oracle Data Integrator - Standalone Collocated Agent. Selecting this one option causes several other options to be selected for you. Click Next to continue.
  • On the Administrator Account panel, enter your password twice. Standard password complexity is expected and enforced. Click Next to continue.
  • On the Domain Mode and JDK panel, select Production in the Domain Mode field and Oracle HotSpot JDK in the JDK field. Click Next to continue.
  • On the Database Configuration Type panel, change the Service to the database service (not database instance), such as orcl.exampledomain.com. Change the Host Name to localhost and change the Schema Password to the password for DEV_STB that you picked when you ran RCU.
  • Click Get RCU Configuration to continue, staying on this panel. The Connection Result Log should end with Successfully Done. Click Next to continue.
  • On the JDBC Component Schema panel, leave the defaults. Click Next to continue.
  • On the JDBC Component Schema Test panel, leave the defaults. The Connection Result Log should end with Test Successful! Click Next to continue.
  • In summary, you have completed the first half, the basic part of the configuration. You must continue with the second half, the advanced configuration.

    Advanced Configuration

    1. On the Advanced Configuration panel, select Administration Server, Node Manager and System Components. Click Next to continue.
    2. On the Administration Server screen, 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.
    3. On the Node Manager screen, select Per Domain Default Location as the Node Manager type and then specify Node Manager credentials.
    4. On the System Components panel, leave the defaults. Click Next to continue.
    5. On the ODI Server Configuration panel, make a note of the Port (you will need that number later), and change the Supervisor Password to the password you picked when you ran RCU. Click Next to continue.
    6. On the Machines panel, select the IP address of the host running Node Manager in the Node Manager Listen Address field. Do not use localhost. Click Next to continue.
    7. On the Assign System Components to Machines panel, leave the defaults. Click Next to continue.
    8. On the Configuration Summary panel, leave the defaults. Click Create to make the domain and continue.
    9. On the Configuration Progress panel, there is nothing to do. Just make sure that it ends with the progress bar at 100% and with the message "Domain Created Successfully!". Click Next to continue.
    10. On the Configuration Success panel, there is nothing to do. Click Finish to end the Configuration Wizard and return to the OS prompt.

    In summary, you completed both halves of the domain configuration. This created several directories with configuration files and scripts.

    ODI 12c - Creating a Collocated Agent (3)Creating a Physical Agent

    The physical agent is a background OS process that communicates with ODI via TCP/IP ports.

    To create, start, and test the physical agent, perform the following steps:

    Creating a Physical Agent

    1. Start ODI Studio by running odi.sh. The splash screen and progress bar displays briefly.
    2. On the Designer or Topology tab, click Connect To Repository...
    3. On the Enter Wallet Password dialog box, enter the password you chose when you installed ODI. Click OK to continue.
    4. On the Oracle Data Integrator Login dialog box, enter the Supervisor's password you chose when you installed ODI. It may be pre-populated for you. Click OK to continue.
    5. On the Topology tab, expand Physical Architecture, then expand Agents. Right-click Agents and select New Agent. An unnamed Agent panel opens on the right.
    6. On the Agent panel, on the Definition tab, in Name, enter the name that matches the agent you created with the earlier domain wizard: OracleDIAgent1.
    7. In Port, enter the port that matches the agent you created with the earlier domain wizard. Verify that Host is correct.
    8. Save your work but do not close the panel. Leave the panel open. You should now see the new agent display on the left under Topology > Physical Architecture > Agents.

    In summary, you created the physical agent configuration for within ODI. This points to the executables created in the previous steps.

    Starting the Standalone Collocated Agent Using Node Manager

    In this method, you need to start Node Manager first and then start the standalone collocated agent.

    1. Navigate to the following directory:
    • (UNIX) setenv JAVA_HOME�/home/Oracle/Java/jdk1.8.0_131
    • (Windows) set JAVA_HOME=C:\home\Oracle\Java\jdk1.8.0_131
  • 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 the directory in which you want to store the log files.

    • (Windows) startNodeManager.cmd
  • Go to the DOMAIN_HOME/bin�directory.
  • Start the agent:
    • (UNIX) ./startComponent.sh OracleDIAgent1
    • (Windows) startComponent.cmd OracleDIAgent1
  • At the prompt, enter the Administrator password for the domain.
  • Starting the Standalone Collocated Agent Without Node Manager

    In this method, you can start the standalone collocated agent using the agent command.

    1. Change to the directory of the domain that contains the binary files.
    2. Start the agent using the agent name from the domain as shown below:
    • (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.

  • Leave that window running (perhaps minimized or sent to the back of the desktop).
  • The very first time you run this, you will get LOTS of output as Java initializes. In subsequent run times, the messages will be fewer. The -PORT parameter is optional but recommended. You want to see at the bottom that the scheduler has started for the correct work repository.

    Testing the Physical Agent

    1. In the OracleDIAgent1 Agent panel (which was left open as mentioned earlier), click Test. This allows you to test the agent now that the process is running outside of ODI. The ODI Information dialog box should say, "Agent Test Successful".
    2. Click OK to continue. You may now close the OracleDIAgent1 tab.

    In summary, you have configured and started a physical agent.

    ODI 12c - Creating a Collocated Agent (4)Creating a Logical Agent

    Most components in ODI have a physical and logical side to them. You already created the physical agent with ports and names. The logical agent is much simpler and shorter.

    To create a logical agent that corresponds with the previous physical agent, perform the following steps:

    1. On the Topology tab, expand Logical Architecture, then expand Agents.
    2. Right-click Agents and select New Logical Agent. An unnamed Logical Agent panel displays on the right.
    3. On the Logical Agent panel, on the Definition tab, in Name, enter MyAgent. In the Physical Agents pull-down, select OracleDIAgent1.
    4. Save your work. You should now see the new agent display on the left under Topology > Logical Architecture > Agents.

    You can close all the open tabs on the right.

    In summary, you created a logical agent to match the previous physical agent.

    ODI 12c - Creating a Collocated Agent (5)Want to Learn More?

    In this tutorial, you should have learned how to:

    • Use the Configuration Wizard to create a domain from a template for a standalone collocated agent
    • Use ODI Studio to create a physical agent
    • Start the physical agent background process from the OS prompt
    • Use ODI Studio to create a logical agent that corresponds to the physical agent

    Resources

    The following are conceptual or procedural Help topics relevant to the topic of this tutorial:

    • Online documentation, viewlets, samples, and OLN URLs on OTN:
      • Current version: here
      • Older versions: here
    • External Web sites for related information:
      • www.oracle.com/goto/odi
      • OTN Community Forums
    • To learn more about Oracle Data Integrator 12c, refer to additional OBEs in the Oracle Learning Library, or on the ODI Studio Start Page.

    Credits

    • User Assistance Developer: Minu Nair
    • Other Contributors: Julien Testut
    ODI 12c - Creating a Collocated Agent (2024)

    FAQs

    How to create an agent in Odi 12c? ›

    To create a logical agent that corresponds with the previous physical agent, perform the following steps:
    1. On the Topology tab, expand Logical Architecture, then expand Agents.
    2. Right-click Agents and select New Logical Agent. ...
    3. On the Logical Agent panel, on the Definition tab, in Name, enter MyAgent . ...
    4. Save your work.

    How to install odi standalone agent? ›

    RUN THE ODI CONFIGURATION UTILITY
    1. Launch the config utility to finish setting up ODI. ...
    2. Create a new domain. ...
    3. Select ODI Standalone agent to create an agent. ...
    4. Specify the location of the Java JDK. ...
    5. Specify connection details using the previously entered RCU Data.
    Apr 2, 2015

    What is an Odi agent? ›

    Agents are multi-threaded java programs that support load balancing and can be distributed across the information system. They hold their own execution schedule, which can be defined in Oracle Data Integrator (ODI), or they can be called from an external scheduler.

    How to create multiple work repositories in Odi 12c? ›

    ODI 12c | Master & Work Repository Setup
    1. Prerequisite: Setup the repository schema first in database(Supported by ODI). ...
    2. Provide all the details for repository connection. ...
    3. Step 2: Provide authentication mode using ODI authentication, provide supervisor password & note it down somewhere as it is required for login setup.

    What is a collocated agent in Odi? ›

    Colocated Agent

    It's like a combo of other two types. The agent is a standalone agent, but it can be monitored and configured through WLS. Unfortunately, it does not take advantage of connection pooling or high availability. Our agent will be in the WLS domain and can be managed through WLS — and that's all.

    How to stop and start an Odi agent? ›

    17.4 Start and Stop ODI Agents
    1. Expand the ODI folder in the Target Navigation pane and click the target link corresponding to your J2EE Agent. The J2EE Agent home page is displayed.
    2. From the Agent menu, select Control.
    3. Perform one of the following actions: Select Start Up to start the agent.

    How to install odi 12c step by step? ›

    0) version.
    1. Lets begin the installation by downloading & unzipping the file.
    2. Prerequisite: Check you java version & set the java variables.
    3. Start the installation using below commands:
    4. Setup the Master Repository,Work Repository & Logins. Refer below blog to setup the master repository, work repository & logins.
    Feb 23, 2020

    How do I restart the Odi agent? ›

    Settings for odi_server -> Control -> Start/Stop page is displayed, in this page we can start or stop ODI server and also check status. Select ODI_SERVER, Click on 'Shutdown' to stop and 'Start' to start ODI server. Select oraclediagent, Click on 'Stop' to stop and 'Start' to start ODI agent.

    What is the default port of ODI agent? ›

    Port on which the agent is listening. Default value is 20910.

    What is the difference between standalone and J2EE agent in ODI? ›

    A J2EE Agent is a JEE application that is deployed and runs on a Managed Server configured in a WebLogic domain. A standalone collocated Agent is a Standalone Agent that is configured in a WebLogic domain and is managed by an Administration Server.

    How to start ODI agent in Windows? ›

    Incode ODI Agent Password
    1. Navigate to the ODI_HOME directory, where ODI is installed and open the agent\bin sub-directory: ( C:\Oracle\Middleware\Oracle_ODI1\oracledi\agent\bin). ...
    2. Leave the text editor open, and open the Command window (Start -> Run -> cmd) and change the directory to the ODI_HOME\agent\bin directory:

    How to create ODI? ›

    To create the ODI target data server and physical schema, perform the following steps:
    1. In ODI, Open ODI Topology Navigator and then select the Physical Architecture tab. ...
    2. In the Data Server: New window, enter the values provided in the table below. ...
    3. Click for JDBC Driver. ...
    4. Click Test Connection. ...
    5. ...

    Can a user create multiple master and work repositories in Odi? ›

    You can have several work repositories, such as DEV (development) and PROD (production), or you can do everything in one work repository. To connect to a particular set of master and work repositories, perform the following steps: Navigate to $ODI_HOME/studio . Start ODI Studio by running script odi.sh .

    What is the master repository in Odi? ›

    Master Repository. Contains topology of resources, security, and version management. A master repository is usually associated with multiple work repositories. Work Repository. Contains data models and projects.

    What is rcu in odi? ›

    This section describes how to use the Repository Creation Utility (RCU) to create the required Oracle Data Integrator schemas. Run the following commands to start the Repository Creation Utility (RCU) and create the ODI schema: cd /u01/app/oracle/middleware/oracle_common/bin. ./rcu.

    How to create an agent in Oracle? ›

    Creating an Agent
    1. In the global header, click New and select Agent. ...
    2. In the Agent editor: General tab, specify the priority of the content that the agent is to deliver and how to generate the delivery content (that is, what user to run the query as).

    How to create mapping in odi 12c? ›

    Using the logical diagram of the mapping editor, you can construct your mapping by dragging components onto the diagram, dragging connections between the components, dragging attributes across those connections, and modifying the properties of the components using the property inspector.

    Top Articles
    Latest Posts
    Recommended Articles
    Article information

    Author: Tuan Roob DDS

    Last Updated:

    Views: 6109

    Rating: 4.1 / 5 (42 voted)

    Reviews: 89% of readers found this page helpful

    Author information

    Name: Tuan Roob DDS

    Birthday: 1999-11-20

    Address: Suite 592 642 Pfannerstill Island, South Keila, LA 74970-3076

    Phone: +9617721773649

    Job: Marketing Producer

    Hobby: Skydiving, Flag Football, Knitting, Running, Lego building, Hunting, Juggling

    Introduction: My name is Tuan Roob DDS, I am a friendly, good, energetic, faithful, fantastic, gentle, enchanting person who loves writing and wants to share my knowledge and understanding with you.