Skip Headers
Oracle® Fusion Middleware Installation Guide for Oracle Data Integrator
11g Release 1 (11.1.1.7.0)

Part Number E16453-06
Go to Documentation Home
Home
Go to Book List
Book List
Go to Table of Contents
Contents
Go to Master Index
Master Index
Go to Feedback page
Contact Us

Go to previous page
Previous
Go to next page
Next
PDF · Mobi · ePub

G OPMN Configuration for Standalone Agent

Oracle Process Monitor and Notification server (OPMN) is used to stop, start and get process status information of system components. OPMN can be obtained by installing Oracle Web Tier; see Oracle Fusion Middleware Installation Guide for Oracle Web Tier for more information. Note that you do not need to configure Oracle Web Tier to obtain OPMN; you can select Install Only - Do Not Configure on the Select Installation Type screen.

The Standalone Agent is a standalone Java process started from a command line interface. This agent is typically deployed locally on the source or target machines for optimal integration flow performances. If you want to use Fusion Middleware Control to start, stop, and monitor the standalone agent, you need to add the Standalone Agent to OPMN and register the OPMN instance with the Administration Server.

This chapter contains the procedure for accomplishing this on WebLogic Server. If you are using IBM WebSphere as your application server, see the instructions in "Configuring OPMN on IBM WebSphere" in Oracle Fusion Middleware Third-Party Application Server Guide.

The following topics are covered:

G.1 Adding a Standalone Agent to OPMN

Follow the instructions in this section to add the standalone agent to OPMN and register OPMN with the Administration Server:

  1. Install Oracle Web Tier in order to get OPMN, and make sure:

    1. Oracle Web Tier must be installed in the same Oracle home as Oracle Data Integrator.

    2. When installing Oracle Web Tier, choose the Install Software - Do Not Configure option on the Select Installation Type screen.

    3. The default instance name is instance1, which will be used in the examples below. If you choose a different instance name, remember to replace instance1 with your own instance name.

  2. In order to configure OPMN to manage a Standalone Agent, with or without registering the OPMN instance to an Administration Server, OPMN needs a properties file containing the properties defined in Table G-1. Note that the values shown may differ from your system configuration.

    The list of properties required are given in the ODI_HOME/oracledi/agent/bin/agentcreate.properties file. Create a copy of this file and provide values for these properties as applicable to your Standalone Agent.

    For example, if you wish to manage two Standalone Agent processes using OPMN, create one copy of agentcreate.properties for each agent (perhaps ODIAgent1.properties and ODIAgent2.properties).

    Note:

    The name of the file does not need to match the name of the agent.

    Table G-1 Parameters in agentcreate.properties

    Parameter Description Example (Your Configurations May Differ)

    PORTNO

    HTTP(S) port number that the Standalone Agent listens on.

    PORTNO=9787

    JMXPORTNO

    JMX port of the ODI Standalone Agent.

    JMXPORTNO=9787

    PROXY_PORT

    OPMN proxy port number.

    PROXY_PORT=98767

    JAVA_HOME

    Location of the JVM used by the ODI Standalone Agent.

    JAVA_HOME=/home/Oracle/Middleware/jdk6_35

    ORACLE_OPMN_HOME

    Oracle home directory for Oracle Web Tier.

    ORACLE_OPMN_HOME=/home/Oracle/Middleware/Oracle_WT1

    ORACLE_ODI_HOME

    Oracle home directory for Oracle Data Integrator.

    ORACLE_ODI_HOME=/home/Oracle/Middleware/Oracle_ODI1

    INSTANCE_HOME

    OPMN Instance home directory.

    INSTANCE_HOME=/home/Oracle/Middleware/Oracle_WT1/instances/instance1

    COMPONENT_TYPE

    Set this property to odiagent.

    COMPONENT_TYPE=odiagent

    COMPONENT_NAME

    Name of the agent you want to add. This will be its identification in OPMN.

    COMPONENT_NAME=OracleDIAgent

    ODI_MASTER_DRIVER

    Name of the JDBC driver used to connect the Master Repository.

    ODI_MASTER_DRIVER=oracle.jdbc.OracleDriver

    ODI_MASTER_URL

    JDBC URL used to connect the Master Repository. Use the format:

    jdbc:oracle:thin:@db_host:port:sid
    

    ODI_MASTER_URL=jdbc:oracle:thin@examplehost.exampledomain:1521:orcl

    ODI_MASTER_USER

    Database account used to connect the Master Repository. This should be the prefix and schema name of the ODI schema created in the database using RCU.

    ODI_MASTER_USER=DEV_ODI_REPO

    ODI_MASTER_ENCODED_PASS

    Database account password. The password must be encoded with the encode.[sh|bat] password command.

    ODI_MASTER_ENCODED_PASS=hpfatLEoMR6zAK3T1PoP5LXDS

    ODI_SECU_WORK_REPO

    Name of the Work Repository to connect. This Work Repository must be attached to the master repository.

    ODI_SECU_WORK_REPO=WORKREP

    ODI_SUPERVISOR_ENCODED_PASS

    OracleDI Supervisor user password. The password must be encoded with the encode.[sh|bat] password command.

    ODI_SUPERVISOR_ENCODED_PASS=hpfatLEoMR6zAK3T1PoP5LXDS

    MASTER_REPO_EXTERNAL_ID

    External ID of the ODI Master Repository. This can be obtained from the Master Repository editor in ODI Studio.

    MASTER_REPO_EXTERNAL_ID=12345


  3. Define the environment variables shown in Table G-2:

    Table G-2 Environment Variables to Define for OPMN Configuration

    Variable Description

    MW_HOME

    Path to the Middleware home directory.

    OPMN_HOME

    Path to the Web Tier Oracle home directory (For example, MW_HOME/Oracle_WT1).

    ODI_AGENT_HOME

    Path to the Standalone Agent directory (for example, ODI_HOME/oracledi/agent).


  4. If you want to register your OPMN instance with the Administration Server, continue with the instructions in this section. If not, skip to Creating an OPMN Instance Without Registering with the Administration Server later in this section.

  5. Create an OPMN instance using the opmnctl createinstance command. Before running this command ensure that the value of the ODI_AGENT_HOME environment variable is set correctly to the path to the Standalone Agent directory. This command must also be run in the same shell where the ODI_AGENT_HOME environment variable is defined.

    Be sure to replace the variables with the actual values on your own system. The instance_specified_in_properties_file must be the instance you specified in your properties file in Step 2.

    cd WT_ORACLE_HOME/opmn/bin
    ./opmnctl createinstance
       -oracleInstance instance_specified_in_properties_file
       -oracleHome OPMN_HOME
       -adminHost administration_server_host
       -adminPort administration_server_port
    

    When this command is executed, you will be prompted to enter the credentials to log in to the Administration Server. Provide the Administration Server user name and password to continue.

  6. Create an OPMN component for the ODI Standalone Agent in the instance created above using the opmnctl createcomponent command. Be sure to replace the variables with your own values. The path_to_properties_file must be the absolute path to the properties file you created in Step 2.

    cd WT_ORACLE_HOME/instances/instance1/bin
    ./opmnctl createcomponent
       -componentType odiagent
       -componentName name_of_physical_agent
       -propertiesFile path_to_properties_file
    
  7. Start the ODI Standalone Agent:

    ./opmnctl startall
    
  8. Login to Fusion Middleware Control and verify that the Standalone Agent has been discovered.

Creating an OPMN Instance Without Registering with the Administration Server

Follow the instructions in this section to create an OPMN instance without registering with the Administration Server.

  1. Create an OPMN instance (if one does not already exist) in the Instance home specified in the INSTANCE_HOME property in the properties file created in Step 2.

    Run the following commands and replace the variables with the values on your system. Replace OPMN_instance_home_directory with the same value you specified for the INSTANCE_HOME properties in the properties file created in Step 2.

    cd OPMN_HOME/opmn/bin
    ./opmnctl createinstance
       -oracleInstance OPMN_instance_home_directory
       -oracleHome OPMN_HOME
       -adminRegistration OFF
    
  2. Create an OPMN component for the ODI Standalone Agent in the instance created above using the opmnctl createcomponent command. This command must be run from the OPMN_instance_home_directory specified in the previous command.

    cd OPMN_instance_home_directory
    ./opmnctl createcomponent
       -componentType odiagent
       -componentName name_of_physical_agent
       -propertiesFile path_to_properties_file
    

    Be sure to replace the variables with your own values. The path_to_properties_file must be the absolute path to the properties file you created in Step 2.

G.2 Stopping the Agent

To stop all agent components in an Oracle instance using opmnctl:

opmnctl stopproc process-type=odiagent

To stop a specific agent component (for example, odiagent1) using opmnctl:

opmnctl stopproc ias-component=odiagent1

G.3 Starting the Agent and Agent Components

To start all agent components in an Oracle instance using opmnctl:

opmnctl startproc process-type=odiagent

To start a specific agent component (for example, odiagent1) using opmnctl:

opmnctl startproc ias-component=odiagent1

G.4 Determining the Status of Oracle HTTP Server

You can determine the status of Oracle HTTP Server using opmnctl:

opmnctl status

G.5 Deleting the Agent

Run the following command to delete an Standalone Agent component from an OPMN instance:

cd INSTANCE_HOME/bin
./opmnctl stopproc ias-component=physical_agent_name
./opmnctl deletecomponent -componentName physical_agent_name

G.6 Updating the Agent Setting Information

Use the commands in this section to change/update the standalone Agent's settings after changing the properties in the agentcreate.properties file.

For Standalone Agent components registered to the Administration Server:

cd INSTANCE_HOME/bin
./opmnctl updatecomponentregistration
   -componentType odiagent
   -componentName physical_agent_name
   -propertiesFile path_to_properties_file
./opmnctl stopall
./opmnctl startall

For Standalone Agent components not registered to the Administration Server:

cd INSTANCE_HOME/bin
./opmnctl deletecomponent -componentName physical_agent_name
./opmnctl createcomponent
   -componentType odiagent
   -componentName physical_agent_name
   -propertiesFile path_to_properties_file