Configuring a standalone agent with OPMN

Oracle Process Manager and Notification Server (OPMN) provides the ability to manage the lifecycle of ODI standalone agents. Using OPMN Oracle Data Integrator, users can control and monitor the status of standalone agents in Oracle Enterprise Manager. In addition, OPMN can automatically restart ODI standalone agents in case of failures.

Getting ready

In this recipe, we will be using the Oracle Web Tier Utilities installer, which contains OPMN. At the time of writing, the installer for Oracle Fusion Middleware Web Tier Utilities 11g can be downloaded from the Oracle Software Delivery Cloud (https://edelivery.oracle.com/) as part of the 'Oracle Fusion Middleware 11g Media Pack'. Make sure to download the right version for your operating system.

An agent named ODI_OPMN_AGENT needs to be defined as a Physical Agent in your ODI Topology.

No other prerequisites are required.

How to do it...

1. Start the Oracle Fusion Middleware Web Tier Utilities 11g installer from its installation directory.

2. In the Install and Configure section, select Install and Configure and click on Next.

   

3. In the Configure Components part of the installer, check the Oracle HTTP Server and Oracle Web Cache checkboxes and then click on Next.

   

4. In the Specify Component Details step, we use the default installation setting for the Instance Home Location, Instance Name, OHS Component Name, and Web Cache Component Name options:

   

5. Click on Next to go to the next installer screen.

6. In the Web Cache Administrator Password screen, enter the password of your choice. In this recipe, we use welcome1 and click on Next.

7. In the Configure Ports step, select Auto Port Configuration and click on Next.

8. Finally, click on Install in the Installation Summary screen to start the Oracle Web Tier Utilities installation process.

9. Once OPMN is installed, go to your ODI_HOME/oracledi/agent/bin/ directory and open up the agentcreate.properties file to edit it. The parameters in this file need to be modified to correspond to your ODI and OPMN configuration settings. In this recipe we use the following values:

   ORACLE_ODI_HOME=C:/fmw/Oracle_ODI_1
   INSTANCE_HOME=C:/fmw/Oracle_WT1/instances/instance1
   COMPONENT_TYPE=odiagent
   COMPONENT_NAME=ODI_OPMN_AGENT
   ODI_MASTER_DRIVER=oracle.jdbc.OracleDriver
ODI_MASTER_URL=jdbc:oracle:thin:@localhost:1521:orcl
   ODI_MASTER_USER=ODI_REPO_11G
   ODI_MASTER_ENCODED_PASS=dpfHbipjYbBAfm7P,Dt69kPBV
   ODI_SECU_WORK_REPO=ODI_11G_WREP
   ODI_SUPERVISOR_ENCODED_PASS=d,yXMMv0Rk6rgNVKEnBb1xE.E
   PORTNO=20920
   JAVA_HOME=C:/Java/jdk1.6.0_24
   ORACLE_OPMN_HOME=C:/fmw/Oracle_WT1
   JMXPORTNO=21920

   The path values to provide such as ORACLE_ODI_HOME or INSTANCE_HOME must be by using forward slashes ('/') and not backward slashes ('\').

   Note

   The encoded passwords, such as ODI_MASTER_ENCODED_PASS or ODI_SUPERVISOR_ENCODED_PASS, can be obtained using the encode.bat or encode.sh command provided in the ODI_HOME/oracledi/agent/bin directory.

10. Next, open up the odi_opmn_addagent.bat or odi_opmn_addagent.sh script and enter the path values for ODI_HOME and OPMN_HOME. We use the following values in this recipe:

    if "%ODI_HOME%" == "" set ODI_HOME=C:/fmw/Oracle_ODI_1/oracledi/agent
    REM call "%ODI_HOME%\bin\odiparams.bat"
    
    if "%OPMN_HOME%" == "" set OPMN_HOME=C:/fmw/Oracle_WT1
    if "%INSTANCE_HOME%" == "" set INSTANCE_HOME=C:/fmw/Oracle_WT1/instances/instance1

11. Go to OPMN_HOME/instances/INSTANCE_NAME/bin, in which INSTANCE_NAME needs to be replaced by the OPMN instance name created earlier with the Web Tier Utilities installer (instance1 in our recipe).

12. Then run the following command to start OPMN:

    opmnctl.bat start
    

13. Once OPMN is started, navigate to ODI_HOME/oracledi/agent/bin/ in your command prompt and run the following command to add a standalone agent to OPMN:

    odi_opmn_addagent.bat
    

14. Subsequently, go back to OPMN_HOME/instances/INSTANCE_NAME/bin and enter the following command to verify that the ODI standalone agent named ODI_OPMN_AGENT is started:

    opmnctl.bat status
    

    

15. The agent ODI_OPMN_AGENT has now been successfully started and is now managed by OPMN. You can test the connection to the agent from Topology Navigator in ODI Studio.

How it works...

The agentcreate.properties file contains all the required information for OPMN to manage a standalone agent. We'll take a look at some of those parameters:

• ORACLE_ODI_HOME represents the path to the ODI installation directory

• INSTANCE_HOME points to the OPMN instance home directory

• COMPONENT_NAME is the name of the Physical Agent that will be managed through OPMN

• ODI_MASTER_DRIVER and ODI_MASTER_URL respectively represent the class name of the JDBC driver and the JDBC URL used to connect to the Master repository

• ODI_MASTER_USER and ODI_MASTER_ENCODED_PASS are the database username and encoded password required to access the Master repository

• ODI_SECU_WORK contains the name of the Work Repository

• ODI_SUPERVISOR_ENCODED_PASS stores the encoded ODI Supervisor user password

• PORTNO corresponds to the port number the agent will be listening to

• JMX_PORTNO is the Java Management Extensions (JMX) port number the agent will be using. JMX is used to propagate events from the agent to monitoring applications such as Oracle Enterprise Manager.

There's more...

The odi_opmn_deleteagent command allows users to remove agents that were previously added to the OPMN configuration settings. It is also possible to stop and restart the ODI agents' processes using the opmnctl command.