ODI11g: Deploying and Configuring the ODI Agent as a Java EE Application


<Do not delete this text because it is a placeholder for the generated list of "main" topics when run in a browser>


This tutorial walks you through the steps that are needed to deploy and configure an Oracle Data Integrator (ODI) Java EE Agent

Time to Complete

Approximately 20 minutes


A common task that is performed using ODI is to deploy and configure an ODI Java EE Agent. With ODI 11g, the Runtime Agent can now be deployed as a Java EE component within an application server. It benefits in this configuration from the application server layer features such as clustering and connection pooling for large configurations. This Java EE Agent exposes an MBeans interface enabling lifecycle operations (start/stop) from the application server console and metrics that can be used by the application server console to monitor the agent activity.


Linda works as a database administrator for Global Enterprise. In Global Enterprise, Linda is responsible for performing database management and integration tasks on various resources within the organization. In particular, Linda is responsible for data loading, transformation, and validation. To begin working on her projects, Linda created the new Master repository and Work repository. Linda also created the project and the procedure to create a relational table and populate it with data. Now Linda needs to deploy and configure an ODI Java EE Agent to be able monitor the agent activity via WebLogic server console.

Software and Hardware Requirements

The following is a list of software requirements:


Before you start the tasks, make sure that your system environment meets the following requirements:


Have installed Oracle Database 11g. If not done before, start the services and components for Oracle Database 11g


Have installed Oracle Data Integrator 11gR1


Before attempting this OBE, you should have successfully completed the following OBEs:

  • ODI11g: Creating and Connecting to ODI Master and Work Repositories
  • ODI11g: Creating an ODI Project: Developing an ODI XML to Database Transformation Using Interface with ODI Constraint. Note: Alternatively you may have your own ODI interface created and used for testing ODI JEE agent . In this case you don't have complete this OBE.

To access these OBEs, click HERE.


Deploy and Configure a New Domain with WebLogic Server

Oracle Data Integrator provides a wizard to automatically generate templates for deploying Java EE agents in Oracle WebLogic Server. Such a template includes the Java EE Agent and its configuration, and can optionally include the JDBC datasources definitions required for this agent as well as the drivers and libraries files for these datasources to work. By using the Oracle WebLogic Configuration Wizard, domain administrators can extend their domains or create a new domain for the Oracle Data Integrator Java EE runtime agents. The ODI 11g Java EEAgent can be deployed to an existing domain or deployed automatically when creating a new domain. For the purpose of this lab we will first create the WLS domain, and then extend the domain by depying the Java EE agent. Before creating an ODI JEE agent, you create a new WLS domain, ODI-DOMAIN. To do so, perform the following steps:


To deploy and configure domains with WLS, you start the config.bat from within the ODI Home Install. Start command shell and change directory to: <WLS-HOME>\common\bin, for example: C:\oracle\Middleware\Oracle_ODI2\common\bin. Execute config command. The Configuration Wizard starts.


In Welcome screen, select Create a new WebLogic domain, and click Next. In the Select Domain Source screen, just click Next.


In Specify Domain Name and Location screen, enter ODI-DOMAIN for Domain name. Leave default Domain location. Click Next. In the screen that follows, enter Administrator user password: "welcome1". Leave User name as "weblogic". Click Next. In the next screen, leave default location for available JDKs. Leave other default settings, as shown on the screenshot and click Next.


In the Select Optional Configuration screen, select: Administration Server, Managed Servers, Clusters and Machines. Click Next. In the screen that follows, verify that Listen port is set to 7001. Click Next. In the screen that follows, click Add to add a new managed server. It will be used later to depoy ODI JEE agent.


In the Configure Managed Server screen, in the Name field enter: odi_server1. In the Listen Port field, enter: 8001, as shown on the screenshot. Click Next. In the screen that follows, click Next.


In the Configure Machines screen, click Next. In Configuration Summary screen, click Create. When the domain is created, click Done.

Note: Don't select "Start Admin server" yet. It will be done later.

Deploy and configure the ODI Java EE agent on the existing WebLogic domain, ODI-DOMAIN.

Now that you have created the WebLogic server domain ODI_DOMAIN, you need to deploy and configure ODI JEE agent with this domain.


If not started, start ODI and connect to ODI Work repository (WORKREP1). For user SUPERVISOR, eneter password: SUNOPSIS. Open Topology Navigator, open Physical architecture and then create a new ODI Agent. Name this agent OracleDIAgent. Set the port to 8001 and Host to localhost . Verify that the Web application context is set to oraclediagent , as shown below. Save your new physical agent .

Note: The agent name is case-sensitive! Use the exact name OracleDIAgent, as shown in the screenshot.



In the Logical architecture, create a new logical agent with the same name as your new physical agent, OracleDIAgent . Link this logical agent to the physical agent OracleDIAgent in Global context, as shown below. Save logical agent OracleDIAgent, and close the tab.




Open the Command Prompt window again. If necessary, change directory to: <WLS-HOME>\common\bin. Execute config command. The Configuration Wizard starts.


In the Welcome screen, select: Extend an existing WebLogic domain. Click Next. In the screen that follows, select the domain ODI-DOMAIN, as shown on the screenshot. Click Next.


In the screen that follows, select Oracle Data Integrator – Agent – (Oracle JRF will then also be selected; leave this option selected). Click Next. In the screen that follows, click OK to replace the existing component odi_server1, that was created earlier.


The wizard will set up the ODI repository connection within the domain server. During the wizard configuration, the repository connection information must be supplied. Click the check boxes next to ODI Master schema, and next to ODI Work schema. Configure the JDBC component schema as shown in the following table. Click Next. Verify that the test was successful (if not, correct any connectivity settings). Click Next.

Database Connection (Master Repository)






Oracle’s driver (Thin) for Instance connections

Schema Owner


Schema Password




Host Name





In the next screen, select Managed Servers, Clusters and Machines. Click Next. Verify that Listen port is set to 8001 for managed server odi_server1. Click Next. In the Configure Clusters screen, click Next.


In the Configure Machines screen, click Next. The Assign Servers to Machines screen will already have the odi_server1 assigned to localODImachine. Click Next. Review the Configuration Summary, and then click Extend. When the domain is created, click Done.

Connecting to the WebLogic server and managed server odi_server1 .

Now that you have created and extended the WebLogic domain with the ODI JEE agent, you need to connect to WebLogic server and managed server odi_serevr1.


In the command shell, change directory to the directory of the WLS Home - C:\Oracle\Middleware\user_projects\domains\ODI_DOMAIN\bin . Execute the startweblogic command.



Security must be set up for the JAVA EE application to have access to the ODI repository. The entry will be created within the credential store, which will allow the JAVA EE Agent to authenticate itself to be able to use the required resources. This user should be a user that is already set up in the ODI Security. In this practice, we use user SUPERVISOR. To do this, you execute Web Logic Scripting Tool (WLST), connect to our running Admin server and add the credential store. To start WLST, in the new command window, change directory to the WLS_HOME common bin - C:\Oracle\Middleware\oracle_common\common\bin, and then execute the command wlst.


To connect to the running Admin server, execute the following command: connect('weblogic','welcome1','t3://localhost:7001')


Execute the following command to add the correct credential store for ODI Supervisor : createCred (map="oracle.odi.credmap", key="SUPERVISOR", user="SUPERVISOR", password="SUNOPSIS", desc="ODI SUPERVISOR Credential").

Note: All commands are case-sensitive! You can copy commands from the text file provided HERE.


IAlso execute the command to add the correct credential store for the domain ODI-DOMAIN :
createCred (map="oracle.odi.credmap", key="ODI-DOMAIN", user="weblogic", password="welcome1", desc="ODI-DOMAIN Credential").
To exit WLST, execute the command exit() .


To start managed server odi_server_1, change directory to WLS Home - C:\Oracle\Middleware\user_projects\domains\ODI-DOMAIN\bin , and use the execute command:
StartManagedWeblogic odi_server1. For Username, enter weblogic . For the password, enter welcome1 . Verify that your managed server is started in RUNNING mode.


From ODI Designer, click Test icon to test connectivity of your configured ODI Java EE agent. Click OK. Close OracleDIAgent tab.

Executing an ODI Object with ODI Java EE Agent

With ODI Agent, expand the project and execute the PRGcreate-populate_table procedure that creates and populates a relational table. This procedure was created in the OBE titled Creating an ODI Procedure to Create and Populate a Relational Table. To access this OBE, click HERE.


In ODI designer, right-click the PRGcreate-populate_table procedure and select Execute. In the window that appears, click the Agent drop-down list and select localagent. Click OK to execute the job with the OracleDIAgent agent. When the Information screen shows the "Session started" message, click OK.




Click the ODI Operator tab to open ODI Operator. In ODI Operator, click the Session List tab, and then click the Refresh icon. Expand: Physical Agent > OracleDIAgent -1> PRD_CREATE_POPULATE_TABLE, and view the execution results for the PRD-create-populate-table procedure. Verify that procedure PRD-create-populate-table executed successfully.


To stop managed WebLogic server odi_server1 and then WebLogic server, change directory to WLS Home - C:\Oracle\Middleware\user_projects\domains\ODI-DOMAIN\bin, and then execute the following command: stopManagedWebLogic odi_server1. For Username, enter weblogic . For the password, enter welcome1 .

To stop WebLogic server, execute the command: stopWebLogic.



In this tutorial, you have learned how to:



Hardware and Software Engineered to Work Together About Oracle |Oracle and Sun | Oracle RSS Feeds | Careers | Contact Us | Site Maps | Legal Notices | Terms of Use | Your Privacy Rights