Setting Up and Installing an ODI Agent as a Background Service

Purpose

This tutorial walks you through the steps that are needed to set up and install an Oracle Data Integrator (ODI) Agent as a background service.

 

Time to Complete

Approximately 20 minutes

Topics

This OBE tutorial covers the following topics:

 Overview

Scenario

 Verifying the Prerequisites
 Setting Up the ODI Agent
 Installing the ODI Agent as a Service
 Setting Up the ODI Agent with ODI Topology Manager
 Executing an ODI Object with the ODI Agent
 Summary

Viewing Screenshots

 Place the cursor over this icon to load and view all the screenshots for this tutorial. (Caution: Because this action loads all screenshots simultaneously, the response time may be slow depending on your Internet connection.)

Note: Alternatively, you can place the cursor over each individual icon in the following steps to load and view only the screenshot associated with that step.

The screenshots will not reflect the specific environment that you are using. They are provided to give you an idea of where to locate specific functionality in Oracle Data Integrator.

Overview

A common task that is performed using ODI is to set up and install ODI Agent as a service. 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. The ODI Agent can be installed as a service to allow for lights-out processing of ODI scenarios. This tutorial walks you through the steps that are needed to set up and install the ODI Agent as a service. For this example, you use the ODI procedure that was created in the OBE titled Creating an ODI Procedure to Create and Populate a Relational Table. You also verify the execution of the procedure within ODI Operator.

Back to Topic List

Scenario

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 set up and install an ODI Agent as a service.

Back to Topic List

Verifying the Prerequisites

Before you start the tasks, make sure that the following requirements are met:

If not done before, start the services and components for Database 10g XE and Oracle Data Integrator 10g (10.1.3.4).

Back to Topic List

 

Setting Up the ODI Agent


To set up a new ODI Agent, perform the following steps:

1.

Navigate to the ODI_HOME directory where ODI is installed and open the bin directory (for example, I:\ODI\oracledi\bin). Navigate to the odiparams.bat file and open it to edit with a text editor.

 

2.

Open the Command window and change the directory to the ODI_HOME\bin directory. An example is shown in the following screenshot.

Note: ODI_HOME is the directory in which ODI is installed. In your system, you may have a different path to the ODI_HOME directory.

 

3.

You need to edit the odiparams.bat file to set the repository connection information for the ODI Agent to use. The password information is stored as an encrypted string with the odiparams.bat file. To encrypt the file, use the agent command: agent encode <password>. Because your password is password, the command looks as shown below. In the Command window, enter and execute this command to retrieve the encoded password. You need it to edit the repository connection information for the ODI Agent.

agent encode password

 

 

4.

Copy the generated encrypted password from the Command window and insert it into the odiparams.bat file as the value for the ODI_SECU_ENCODED_PASS parameter. Verify the settings for the other parameters from the following table, save the odiparams.bat file, and then close it. The agent’s connectivity is now set up.

rem
                                      
rem Repository Connection Information
rem
set ODI_SECU_DRIVER=oracle.jdbc.driver.OracleDriver
set ODI_SECU_URL=jdbc:oracle:thin:@localhost:1521:XE
set ODI_SECU_USER=snpm1
set ODI_SECU_ENCODED_PASS= a7yaNb4YyqTYeSArphL0k9tJp
set ODI_SECU_WORK_REP=WORKREP
set ODI_USER=SUPERVISOR
set ODI_ENCODED_PASS=LELKIELGLJMDLKMGHEHJDBGBGFDGGH

Note: The ODI_SECU_ENCODED_PASS parameter is different each time it is generated. In the odiparams.bat file, the ODI_ENCODED_PASS parameter is set to the encoded password for SUNOPSIS by default. This does not need to be modified unless the SUPERVISOR password has been changed.


Back to Topic List

Installing the ODI Agent as a Service

The agent can be executed directly from the command line but it will not run in the background if you do so. This section explains how to install the ODI Agent as a service. Perform the following steps:

1.

Open the Command window and navigate to the ODI_HOME\bin directory if not done before. Execute the agentservice.bat file using the following command:

                                       
agentservice -i –a
                                    

 

 

 

2.

The Agent is now successfully installed as a service. However, the Agent service will not be started when it is installed. To start the Agent service, navigate to Services and start the OracleDI Agent service. The ODI Agent is now set up as a service and successfully started.

 

 

Back to Topic List

Setting Up the ODI Agent with ODI Topology Manager

To set up the ODI Agent with the Topology Manager, perform the following steps:

1.

Start ODI Topology Manager: Start > All Programs > Oracle > Oracle Data Integrator > Topology Manager. Select Master Repository. The default User name and Password are preset as SUPERVISOR and SUNOPSIS. Click OK to log in to the Master repository.

Note: The Master repository was created in the OBE titled Creating and Connecting to ODI Master and Work Repositories. To access this OBE, click HERE.

 

 

2.

On the screen that follows, click the Physical Architecture tab  . Right-click Agents and select Insert Agent.

 

 

3.

On the Agent: New screen that follows, set the Name to localagent and set the Host to localhost. Set the Port to the default 20910. Leave other settings as the defaults. Click the Test button, and then click Yes. The following success message should appear. Click OK.

Note: If the test is not successful, make sure that the agent service is started and the parameters in the odiparams.bat file are correct.

 

4.

Click OK on the Agent: localagent screen. Expand the Agents node and verify that your new agent localagent appears in the Physical Architecture tree structure. The Physical Agent is now set up successfully.

 

5.

Click the Logical Architecture tab  . Right-click Agents and select Insert Logical Agent. On the screen that follows, set the Name to localagent. Set Physical Agents to localagent. Click OK. Verify that your new logical agent localagent appears in the Logical Architecture tree structure.

Back to Topic List

 

Executing an ODI Object with the ODI Agent

With ODI Agent, you 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.

Note: Before executing the procedure, make sure that the table that this procedure will create does not exist. If this table exists, it should be dropped. To execute the procedure with the ODI Agent, perform the following steps:

1.

Start the Oracle XE Database Home Page: Start > All Programs > Oracle Database 10g Express Edition > Go to Database Home Page. The Login screen appears. Log in to the database as user ODI_STAGE3. The password for this user is password.

 

2.

On the Oracle Database Express Edition Home screen, select SQL Commands > Enter Command from the SQL drop-down list. Enter and run the following statement. If the SRC_SALES_PERSON tables exists, it is dropped. Otherwise, the message " table or view does not exist" is displayed.

drop table ODI_STAGE3.SRC_SALES_PERSON

 

3.

Start ODI Designer: Start > All Programs > Oracle > Oracle Data Integrator > Designer. Select WORKREP from the Login Name drop-down list if not already selected. Click OK.

 

4.

On the Designer screen, click the Projects tab  and expand ODICreate_Table > First Folder > Procedures.

 

5.

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 localagent agent. When the Information screen shows the " Session started" message, click OK.

 

6.

To verify that your procedure was executed successfully, you need to open ODI Operator. Click the ODI Operator icon  to start ODI Operator. In ODI Operator, expand Date > Today > Steps > PRGcreate-populate_table and view the execution results for each step. You have now successfully executed an ODI object on an ODI Agent.

Note: If you want to execute the procedure again, you have to first drop the SRC_SALES_PERSON table as described in step 2.

Back to Topic List

 

Summary

In this lesson, you learned how to:

 Verify the Prerequisites
 Set up the ODI Agent
 Install the ODI Agent as a Service
 Set up the ODI Agent with ODI Topology Manager
 Execute an ODI Object with the ODI Agent

 

Back to Topic List

 

 Place the cursor over this icon to hide all screenshots.

 

 

 

Left Curve
Popular Downloads
Right Curve
Untitled Document