10/07/12

Print Preview

Configuring OPMN to Manage ODI Standalone Agents

Configuring OPMN to Manage ODI Standalone Agents

This tutorial contains the follow ing sections: Purpose Time to Complete Overview Scenario Softw are and Hardw are Requirements Prerequisites Dow nloading OPMN from the Oracle Web Tier Utilities 11g Installation Set Checking the Version of Java on Your Workstation Setting Up the Environment Adding the ODI 11g Standalone Agent to OPMN How to Stop the Agent Troubleshooting the Inability to Start the Agent Due to Backslashes Summary Resources

Configuring OPMN to Manage ODI Standalone Agents

Purpose
This tutorial walks you through the steps needed to configure Oracle Process Manager and Navigation server (OPMN) to manage Oracle Data Integrator 11g (ODI) standalone agents. You learn what are the prerequisites, where to download OPMN if not already available, how to add an ODI 11g standalone agent to OPMN, how to start and stop an ODI standalone agent with OPMN, and issues that might arise and how to resolve them.

Time to Complete
Approximately 20 minutes

Overview
The ODI standalone agent is a standalone Java process that runs in a non-JEE environment. This agent can be used to execute ODI scenarios on predefined schedules or on demand. This standalone agent is typically deployed locally on the source or target machines for optimal integration flow performances. Once the standalone agent has been defined in ODI Topology Manager, it can be started. The ODI standalone agent can be started from a command line interface, or it can be controlled by a number of other methods. One of the alternative methods for controlling the ODI standalone agent is the use of OPMN. OPMN can help manage process control actions like start, stop, and restart of JEE and non-JEE applications. You can use OPMN to start, stop, and monitor the ODI standalone agent. ODI 11g does not include a standalone version of OPMN. Fortunately, OPMN is included in the installation of several Oracle middelware products such as Oracle Enterprise Performance Management suite and Oracle Application Server. However, if OPMN is not already available in your environment via middleware, you can download OPMN separately. This OBE tutorial includes a section describing how to download OPMN separately by downloading a subset of Oracle Web Tier Utilities 11g. Note: The steps to configure OPMN to manage ODI standalone agents are also outlined in the ODI 11g Installation Guide. In this tutorial, you learn how to:

Viewing Screenshots
Click icon to hide all screenshots Note: Alternatively, you can click an individual icon (or image) associated w ith each step to view (or hide) the screenshot associated w ith that step.

Identify the software prerequisites, and download OPMN if not already available Add an ODI 11g standalone agent to OPMN Start an ODI standalone agent from opmnctl Stop an agent from opmnctl Restart an agent from opmnctl Check the status of the Agent (Up or Down) Identify issues that might occur and how to resolve them

Scenario
You work as a database administrator for Global Enterprise. You are responsible for managing the execution of ODI scenarios. Until now, you have run scripts to start and stop the ODI standalone agents that execute ODI scenarios. You have learned that you can use OPMN as an alternative method of managing the ODI standalone agents. Although your workplace environment does not have the Oracle middleware products that include OPMN, you are willing to download OPMN and try using it to manage your agents. This diagram shows three possible methods of managing an ODI standalone agent: Using agent start/stop scripts from the ODI environment Using OPMN obtained by downloading Oracle Web Tier Utilities 11g Using OPMN available from an existing installation of Oracle Application Server

Of those three methods, this OBE tutorial focuses on the steps required for managing an ODI standalone agent using OPMN that is installed from the Oracle Web Tier Utilities 11g.

www.oracle.com/webfolder/technetwork/tutorials/obe/fmw/odi/odi_11g/odi_opmn/odi_opmn.htm

1/7

10/07/12

Configuring OPMN to Manage ODI Standalone Agents

Software and Hardware Requirements

The following is a list of software requirements: The system should include the following installed products: Oracle Database 11g Oracle Data Integrator 11g Release 1 Oracle Process Manager and Navigation Server (OPMN) If OPMN is not already installed as part of your Oracle middleware environment, use the section below to download OPMN as a subset of Oracle Web Tier Utilities 11g.

Prerequisites
Before you start the tasks, make sure that your system environment meets the following requirements: 1. You have installed Oracle Database 11g. If not done before, start the services and components for Oracle Database 11g. 2. You have installed Oracle Data Integrator 11g Release 1. You have access to an existing OPMN installation that is part of your Oracle middleware environment, or you will 3. download and install OPMN as part of the Oracle Web Tier Utilities 11g.

Downloading OPMN from the Oracle Web Tier Utilities 11g Installation Set

1. If you need to download OPMN, OPMN is included in any type of Oracle Application Server installation. However, we recommend obtaining OPMN fr package, as it allows you to choose to install OPMN only. Access the website for downloading Oracle Web Tier Utilities 11g from OTN, by clicking here.

2. Download Oracle Web Tier Utilities 11.1.1.2.0 (this is a full install).

3. Unzip and launch the installer. For example, click on the setup located under C : \ o f m _ w e b t i e r _ w i n _ 1 1 . 1 . 1 . 2 . 0 _ 3 2 _ d i s k 1 _ 1 o f 1 \ D i s k 1 \ i n s t

4. Check the check boxes for Oracle HTTP Server and Oracle Webcache only, at the installation wizard's Configure Components window. These two components that you need.

www.oracle.com/webfolder/technetwork/tutorials/obe/fmw/odi/odi_11g/odi_opmn/odi_opmn.htm

2/7

10/07/12

Configuring OPMN to Manage ODI Standalone Agents

5 . Download Oracle Web Tier 11.1.1.3.0. (This is a patchset.)

6 . Launch the installer, and patch Oracle Web Tier 11.1.1.2.0 to 11.1.1.3.0. If you wish, you may consult the Oracle Web Tier installation guide.

Checking the Version of Java on Your Workstation

You may have an existing ODI standalone agent that you wish to add to OPMN. Otherwise, you can create an ODI standalone agent using the ODI S

Before being added to OPMN, the existing or new ODI standalone agent needs to be tested to ensure it starts successfully (from the command pro resides. This involves the following workflow: Check the version of Java on your workstation. Install the ODI 11g standalone Agent on the same host on which Oracle Web Tier is installed. Define that agent in ODI, using ODI Topology Manager. Enter Repository connection and java information in the odiparams.bat or odiparams.sh file. Start the agent from the command prompt to ensure: The port is free. The agent host can connect to your ODI repositories. The Agent process can run with the java version provided. Test the agent in ODI Topology Manager; if successful, stop the agent (we will use OPMN to start it later). If not successful, correct the issue an

1 . Let us address the first task in the workflow list, above. It is essential that you check the Java version in the DOS command shell of the workstation Java Development Kit (JDK) 1.6.0 or higher is essential; the script for adding an agent to OPMN, odi_opmn_addagent, requires the latest JDK 1.6 versions of JDK will not support odi_opm_addagent. To check the version of JDK on your workstation, open a command window and issue the following command: j a v av e r s i o n

If you need to install a recent version of JDK, click here for the Oracle Java download website. On that website, click the "Download JDK" button to d 6u23 for Linux or Windows, which will provide you a version of JDK 1.6.

Check the version of JDK in the PATH variable: 2 . odi_opmn_addagent uses the Java version that appears first in the PATH variable. Therefore, go to My Computer>Properties>Advanced>Environm environment variable, add the path to JDK 1.6 to this variable, and remove any older version of JDK from the path. Note: If you do not put the path to JDK 1.6 in your PATH environment, you will receive the following error: E x c e p t i o ni nt h r e a d" m a i n "j a v a . l a n g . U n s u p p o r t e d C l a s s V e r s i o n E r r o r :B a dv e r s i o n n u m b e ri n. c l a s sf i l e a tj a v a . l a n g . C l a s s L o a d e r . d e f i n e C l a s s 1 ( N a t i v eM e t h o d ) a tj a v a . l a n g . C l a s s L o a d e r . d e f i n e C l a s s ( C l a s s L o a d e r . j a v a : 6 2 0 ) a tj a v a . s e c u r i t y . S e c u r e C l a s s L o a d e r . d e f i n e C l a s s ( S e c u r e C l a s s L o a d e r . j a v a : 1 4 )

Setting Up the Environment

1 . Once you have an ODI standalone agent, either an existing one or newly created one, familiarize yourself with the files you will be using in this tutor Go to the ODI_HOME/oracledi/agent/bin/ directory where the standalone agent has been installed. The files that we will be focusing on in this tutorial are agentcreate.properties, odi_opmn_addagent.bat, odi_opmn_deleteagent.bat, and ( If you are using Unix, the files are appended with .sh instead of .bat.)

2 . Make sure to set JAVA_HOME and ODI_JAVA_HOME in odiparams.bat to the JDK 1.6.

www.oracle.com/webfolder/technetwork/tutorials/obe/fmw/odi/odi_11g/odi_opmn/odi_opmn.htm

3/7

10/07/12

Configuring OPMN to Manage ODI Standalone Agents

Note: The Java path should not have spaces; if it is does, try to use the DOS syntax ~ (for example C:\Progra~1\Java\jdk1.6.0_23 for C:\Program Fil Otherwise, when starting the Agent with opmnctl, it fails and the error below appears in the log file: j a v a . l a n g . N o C l a s s D e f F o u n d E r r o r :F i l e s \ J a v a \ j d k 1 / 6 / 0 _ 2 3 \ l i b \ t o o l s / j a r C a u s e db y :j a v a . l a n g . C l a s s N o t F o u n d E x c e p t i o n :F i l e s \ J a v a \ j d k 1 . 6 . 0 _ 2 3 \ l i b \ t o o l s . j a r a tj a v a . n e t . U R L C l a s s L o a d e r $ 1 . r u n ( U R L C l a s s L o a d e r . j a v a : 2 0 2 ) 3 . Set the environment variables in both the agentcreate.properties file and the odi_opmn_addagent.bat file. They need to be set so that the its references to the jar or class files. a g e n t c r e a t e . p r o p e r t i e s : O R A C L E _ O D I _ H O M E expects the path where ODI 11g is installed. C O M P O N E N T _ N A M E expects the physical Agent name defined in Topology. o d i _ o p m n _ a d d a g e n t . b a t : O D I _ H O M E expects the path of the agent directory under your ODI 11g, for example: C : \ W E B T I E R _ H O M E \ O r a c l e _ W T 1 \ o d i _ s t a n d a l o n e \ o r a c l e d i \ a g e n t All environment variables in o d i _ o p m n _ a d d a g e n t . b a tare set this way, by default: i f" % I N S T A N C E _ H O M E % "= =" "s e tI N S T A N C E _ H O M E = . . You need to set each variable explicitly, according to your environment; for example: i f" % I N S T A N C E _ H O M E % "= =" "s e tI N S T A N C E _ H O M E = C : \ W E B T I E R _ H O M E \ O r a c l e _ W T 1 \ i n s t a n c e s \ i n s t a n c e 1 If the variables are not set correctly, for example the O D I _ H O M E variable, then o d i _ o p m n _ a d d A g e n t will fail with: E x c e p t i o ni nt h r e a d" m a i n "j a v a . l a n g . N o C l a s s D e f F o u n d E r r o r :o r a c l e / o d i / A d d A g e n t T o O p m n C a u s e db y :j a v a . l a n g . C l a s s N o t F o u n d E x c e p t i o n :o r a c l e . o d i . A d d A g e n t T o O p m n a tj a v a . n e t . U R L C l a s s L o a d e r $ 1 . r u n ( U R L C l a s s L o a d e r . j a v a : 2 0 2 ) . . . C o u l dn o tf i n dt h em a i nc l a s s :o r a c l e . o d i . A d d A g e n t T o O p m n .P r o g r a mw i l le x i t . o p m n c t lr e l o a d :r e c o n f i g u r i n go p m n . 4 . After you verify each variable, you may still see the error below when running o d i _ o p m n _ a d d a g e n t . b a t : E r r o rr e a d i n gf i l e P l e a s ep r o v i d et h ev a l u ef o r O R A C L E _ O D I _ H O M E w h i l ey o uh a v es e tO R A C L E _ O D I _ H O M Ec o r r e c t l yi na g e n t c r e a t ef i l e .

This is caused by o d i _ o p m n _ a d d a g e n t . b a tnot finding the a g e n t c r e a t e . p r o p e r t i e sfile that you provided. The name a g e n t c r e a t e . p r o p e r t with its extension . p r o p e r t i e s . If you receive the error above, make sure that you use the correct command syntax to run o d i _ o p m n _ a d d a g e n t . b a t : o d i _ o p m n _ a d d a g e n t" a g e n t c r e a t e . p r o p e r t i e s "

Adding the ODI 11g Standalone Agent to OPMN

1. Launch OPMN and ohs1 from the Start menu. Start>All Programs>Oracle Web Tier Instance-instance 1 >Start Oracle Process Manager Start>All Programs>Oracle Web Tier Instance-instance 1 >Start Oracle HTTP Server-ohs1

Start a command prompt and cd to C : \ W E B T I E R _ H O M E \ O r a c l e _ W T 1 \ i n s t a n c e s \ i n s t a n c e 1 \ b i n Issue the following command to check if OPMN is running and ohs1 is alive: o p m n c t ls t a t u s

2. If you do not already have an existing ODI standalone agent to add to OPMN, your next step is to use the ODI Studio Topology Manager to create a Oracle Data Integrator: Start > Programs > Oracle ODI 11g-Home> Oracle Data Integrator > ODI Studio.

www.oracle.com/webfolder/technetwork/tutorials/obe/fmw/odi/odi_11g/odi_opmn/odi_opmn.htm

4/7

10/07/12

Configuring OPMN to Manage ODI Standalone Agents

Note the Host field contains the Host name where the standalone Agent will be running. In this example, Name is l o c a l _ a g e n t , and port numbe

For more details on adding an ODI standalone agent, see the OBE tutorial ODI11g: Setting up and installing an ODI agent..

3. Check the agentcreate.properties file to make sure each environment variable is set correctly. (You may save a copy of the original outside of the Example agentcreate.properties file content: #U s e/a sp a t hs e p e r a t o rt os p e c i f yp a t hi nU n i xa sw e l la sW i n d o w s . O R A C L E _ O D I _ H O M E = / W E B T I E R _ H O M E / O r a c l e _ W T 1 / o d i _ s t a n d a l o n e I N S T A N C E _ H O M E = / W E B T I E R _ H O M E / O r a c l e _ W T 1 / i n s t a n c e s / i n s t a n c e 1 C O M P O N E N T _ T Y P E = o d i a g e n t C O M P O N E N T _ N A M E = l o c a l _ a g e n t O D I _ M A S T E R _ D R I V E R = o r a c l e . j d b c . O r a c l e D r i v e r O D I _ M A S T E R _ U R L = j d b c : o r a c l e : t h i n : @ l o c a l h o s t : 1 5 2 1 : o r c l O D I _ M A S T E R _ U S E R = O D I M O D I _ M A S T E R _ E N C O D E D _ P A S S = d 1 y a G z W P R i J E d E 5 K L D g d H 5 d p O D I _ S E C U _ W O R K _ R E P O = W O R K R E P 1 O D I _ S U P E R V I S O R _ E N C O D E D _ P A S S = f D y X s q . Y M R u A n 7 h y x 1 D s P O R T N O = 2 0 9 1 0 J A V A _ H O M E = / P r o g r a ~ 1 / J a v a / j d k 1 . 6 . 0 _ 2 3 O R A C L E _ O P M N _ H O M E = / W E B T I E R _ H O M E / O r a c l e _ W T 1 J M X P O R T N O = 2 1 9 1 0

Note: C O M P O N E N T _ N A M Eand P O R T N Ovalues are identical to what you defined in Topology Manager in the previous step for N a m eand P o r tN u m b e J M X P O R T N Ois, by default, the PORTNO + 1000, so in our example it is 2 1 9 1 0 .

4. Check the Environment Variables in odi_opmn_addagent.bat. Example odi_opmn_addagent.bat content: r e mi f" % O D I _ H O M E % "= =" "s e tO D I _ H O M E = . . r e mi f" % O P M N _ H O M E % "= =" "s e tO P M N _ H O M E = . . r e mi f" % I N S T A N C E _ H O M E % "= =" "s e tI N S T A N C E _ H O M E = . . i f" % O D I _ H O M E % "= =" "s e tO D I _ H O M E = C : \ W E B T I E R _ H O M E \ O r a c l e _ W T 1 \ o d i _ s t a n d a l o n e \ o r a c l e d i \ a g e n t i f" % O P M N _ H O M E % "= =" "s e tO P M N _ H O M E = C : \ W E B T I E R _ H O M E \ O r a c l e _ W T 1 i f" % I N S T A N C E _ H O M E % "= =" "s e tI N S T A N C E _ H O M E = C : \ W E B T I E R _ H O M E \ O r a c l e _ W T 1 \ i n s t a n c e s \ i n s t a n c e 1 s e tC L A S S P A T H = % O D I _ H O M E % \ l i b \ o d i s t a n d a l o n e a g e n t . j a r ; % O P M N _ H O M E % \ o p m n \ l i b \ o p m n e d i t o r . j a r j a v ac l a s s p a t h% C L A S S P A T H %o r a c l e . o d i . A d d A g e n t T o O p m n% * C A L L% I N S T A N C E _ H O M E % \ b i n \ o p m n c t lr e l o a d : E N D C O M M A N D

5 . Add the Agent to OPMN by issuing the following command under o r a c l e d i \ a g e n t \ b i n : o d i _ o p m n _ a d d a g e n t" a g e n t c r e a t e . p r o p e r t i e s "

6 . Change directories to C : \ W E B T I E R _ H O M E \ O r a c l e _ W T 1 \ i n s t a n c e s \ i n s t a n c e 1 \ b i nor equivalent where your Web Tier is installed. Issue the following command to verify that the agent has been added:

www.oracle.com/webfolder/technetwork/tutorials/obe/fmw/odi/odi_11g/odi_opmn/odi_opmn.htm

5/7

10/07/12

Configuring OPMN to Manage ODI Standalone Agents

o p m n c t ls t a t u s

7 . Now start the Agent using opmnctl and check its status again: o p m n c t l . b a ts t a r t p r o ci a s c o m p o n e n t = l o c a l _ a g e n t

8 . Test the Agent in ODI Topology Manager now.

Note: If the agent fails to start in the previous step, you may consult its log file located at C : \ W E B T I E R _ H O M E \ O r a c l e _ W T 1 \ i n s t a n c e s \ i n s t a n c e 1 \ d i a g n o s t i c s \ l o g s \ O P M N \ o p m n \ c on s o l e ~ l o c a l _ a g e n t ~ o d i a g e n t ~ 1 . l o g Fix the issue reported by the Agent log (it could be one of the error messages included in this OBE tutorial) then retry starting the agent.

www.oracle.com/webfolder/technetwork/tutorials/obe/fmw/odi/odi_11g/odi_opmn/odi_opmn.htm

6/7

10/07/12

Configuring OPMN to Manage ODI Standalone Agents

How to Stop the Agent

1 . Issue the following command: o p m n c t l . b a ts t o p p r o ci a s c o m p o n e n t = l o c a l _ a g e n t

Troubleshooting the Inability to Start the Agent Due to Backslashes

1 . You may be unable to start the agent using OPMN when the JDBC URL to ODI repositories contains "//" For example, with ODI rRepositories hosted on Microsoft SQL Server, starting the agent using OPMN fails. Upon inspection, the OPMN diagnostic log located at < W e b T I E R _ H O M E > \ O r a c l e _ W T 1 \ i n s t a n c e s \ i n s t a n c e 1 \ d i a g n o s t i c s \ l o g s \ O P M N \ o p m n \ c o n s o l e ~ l o c a l _ a g e n t ~ o d i a g e n t ~ 1 . l o g shows the following error:

C a u s e db y :j a v a . s q l . S Q L N o n T r a n s i e n t C o n n e c t i o n E x c e p t i o n :[ O W L S ] [ S Q L S e r v e rJ D B CD r i v e r ] Av a l u ew a sn o ts p e c i f i p r o p e r t y :s e r v e r N a m ef o rd a t a d i r e c td r i v e r C a u s e db y :j a v a . s q l . S Q L E x c e p t i o n :N os u i t a b l ed r i v e rf o rM SS Q Ls e r v e rd r i v e r .

Further investigation in the OPMN diagnostic log reveals that OPMN is converting the slashes "//" in the JDBC URL to "\\" which is causing the conn

By default, OPMN converts slashes in the data value string to be those of the directory path separator character for the system on which OPMN is ru converted to '/' and on Windows each '/' is converted to '\'). Set this attribute to false to disable conversion. To resolve this issue, edit the opmn.xml file to add process-conversion="false" as shown below.

< v a r i a b l ei d = " O D I _ M A S T E R _ U R L "v a l u e = " j d b c : s q l s e r v e r : / / r p l e w i s l a p . i d c . o r a c l e . c o m : 2 2 1 3 ; d a t a b a s e N a m e = O D I 1 1 G _ M A S T E R ; s c o n v e r s i o n = " f a l s e " / > Please note there is a space before "process-conversion". Restart OPMN and then try to start the ODI standalone agent using OPMN. Additional References for OPMN config file is available here.

Summary
In this tutorial, you have learned how to: Identify the software prerequisites, and download OPMN if not already available Add an ODI 11g standalone agent to OPMN Start an ODI standalone agent from opmnctl Stop an agent from opmnctl Restart an agent from opmnctl Check the status of the Agent (Up or Down) Identify issues that might occur and how to resolve them

Resources
Oracle Data Intergator 11g Documentation To learn more about other Oracle products, refer to additional OBEs on the OLL Web site

About Oracle |Oracle and Sun |

| Careers | Contact Us | Site Maps | Legal Notices | Terms of Use | Your Privacy Rights

www.oracle.com/webfolder/technetwork/tutorials/obe/fmw/odi/odi_11g/odi_opmn/odi_opmn.htm

7/7