14 Configuring Oracle Application Server Integration Business Activity Monitoring

This chapter describes Oracle Application Server Integration Business Activity Monitoring (OracleAS Integration BAM) configuration in the OPMN opmn.xml file.

It features the following topics:

Section 14.1, "OracleAS Integration BAM Process Module Configuration"
Section 14.2, "OracleAS Integration BAM Minimum Configuration"
Section 14.3, "OracleAS Integration BAM Complete Configuration"
Section 14.4, "OracleAS Integration BAM Attribute Descriptions"

14.1 OracleAS Integration BAM Process Module Configuration

The following lines load and identify the process module. Management of OracleAS Integration BAM processes by the process module are identified by the module id.

<module path="$ORACLE_HOME/opmn/lib/libopmnbam.so">
   <module-id id="MonitorFramework"/>
   <module-id id="BAMEngine"/>
</module>

14.2 OracleAS Integration BAM Minimum Configuration

The following lines represent the minimum configuration for OracleAS Integration BAM. Default values are assigned to all other configuration elements and attributes for OracleAS Integration BAM.

<ias-component id="BAM" status="enabled">
   <process-type id="engine" module-id="BAMEngine" >
      <environment>
         <variable id="BAM_PROPERTIES_FILE" value="$ORACLE_HOME/work/BAMProperties/
          bam.properties"/>
         <variable id= "TNS_INSTANCE" value="bamhost"/>
         <variable id="LD_LIBRARY_PATH" value= "/usr/local/lib:/usr/lib:$ORACLE_HOME/lib32"
          append="true"/>
      </environment>
      <process-set id="BAMEngine" numprocs="1">
         <module-data>
            <category id="start-parameters">
               <data id="bin-path" value="$ORACLE_HOME/bam/bin/wsd"/>
            </category>
         </module-data>
      </process-set>
   </process-type>
   <process-type id="monitor" module-id="MonitorFramework">
      <environment>
         <variable id="CLASSPATH" value="$ORACLE_HOME/bam/config" append="true"/>
         <variable id="CLASSPATH" value="$ORACLE_HOME/bam/lib/aqapi.jar" append="true"/>
         <variable id="CLASSPATH" value="$ORACLE_HOME/bam/lib/bam.jar" append="true"/>
         <variable id="CLASSPATH" value="$ORACLE_HOME/jdbc/lib/classes12.jar" append="true"/>
         <variable id="CLASSPATH" value="$ORACLE_HOME/bam/lib/dms.jar" append="true"/>
         <variable id="CLASSPATH" value="$ORACLE_HOME/bam/lib/ip.jar" append="true"/>
         <variable id="CLASSPATH" value="$ORACLE_HOME/bam/lib/b2b.jar" append="true"/>
         <variable id="CLASSPATH" value="$ORACLE_HOME/bam/lib/oai904.jar" append="true"/>
         <variable id="CLASSPATH" value="$ORACLE_HOME/sqlj/lib/runtime12ee.jar" append="true"/>
         <variable id="CLASSPATH" value="$ORACLE_HOME/sqlj/lib/translator.jar" append="true"/>
         <variable id="CLASSPATH" value="$ORACLE_HOME/bam/lib/xmlcomp.jar" append="true"/>
         <variable id="CLASSPATH" value="$ORACLE_HOME/bam/lib/xmlparserv2_10g.jar" append="true"/>
      </environment>
   <process-set id="MonitorFramework" numprocs="1"/>
   </process-type>
</ias-component>

14.3 OracleAS Integration BAM Complete Configuration

The following lines show a complete configuration for OracleAS Integration BAM. It contains all possible configuration elements and attributes for OracleAS Integration BAM.

<ias-component id= BAM status="enabled">
   <process-type id="engine" module-id="BAMEngine">
      <environment>
         <variable id="BAM_PROPERTIES_FILE" value= "$ORACLE_HOME/work/BAMProperties
          /bam.properties"/>
         <variable id="TNS_INSTANCE" value="bamhost"/>
         <variable id="LD_LIBRARY_PATH" value= "/usr/local/lib:/usr/lib:$ORACLE_HOME/lib32"
          append="true"/>
      </environment>
      <process-set id="BAMEngine" numprocs="1">
         <module-data>
            <category id="start-parameters">
               <data id="bin_path" value="$ORACLE_HOME/bam/bin/wsd"/>
            </category>
         </module-data>
      </process-set>
   </process-type>
   <process-type id="monitor" module id="Monitor Framework">
      <environment>
         <variable id="CLASSPATH" value="$ORACLE_HOME/bam/config" append="true"/>
         <variable id="CLASSPATH" value="$ORACLE_HOME/bam/lib/aqapi.jar" append="true"/>
         <variable id="CLASSPATH" value="$ORACLE_HOME/bam/lib/bam.jar" append="true"/>
         <variable id="CLASSPATH" value="$ORACLE_HOME/jdbc/lib/classes12.jar" append="true"/>
         <variable id="CLASSPATH" value="$ORACLE_HOME/bam/lib/dms.jar" append="true"/>
         <variable id="CLASSPATH" value="$ORACLE_HOME/bam/lib/ip.jar" append="true"/>
         <variable id="CLASSPATH" value="$ORACLE_HOME/bam/lib/b2b.jar" append="true"/>
         <variable id="CLASSPATH" value="$ORACLE_HOME/bam/lib/oai904.jar" append="true"/>
         <variable id="CLASSPATH" value="$ORACLE_HOME/sqlj/lib/runtime12ee.jar" append="true"/>
         <variable id="CLASSPATH" value="$ORACLE_HOME/sqlj/lib/translator.jar" append="true"/>
         <variable id="CLASSPATH" value="$ORACLE_HOME/bam/lib/xmlcomp.jar" append="true"/>
         <variable id="CLASSPATH" value="$ORACLE_HOME/bam/lib/xmlparserv2_10g.jar" append="true"/>
      </environment>
         <module-data>
            <category id="start-parameters">
               <data id="java-bin" value="/my/path/to/java/exec"/>
               <data id="java-parameters" value="-ms8m -mx512m"/>
               <data id="class-name" value="MyJavaStartClass"/>
               <data id="application-parameters" value="MyApplicationParameters"/>
            </category>
            <category id="stop-parameters">
               <data id="java-bin" value="/my/path/to/java/exec"/>
               <data id="java-parameters" value="-ms8m -mx512m"/>
               <data id="class-name" value="MyJavaStopClass"/>
               <data id="application-parameters" value="MyApplicationParameters"/>
               <data id="stop-option" value="MyStopOption"/>
            </category>
         </module-data>
         <process-set id="MonitorFramework" numprocs="1"/>
      <stop timeout="MyStopTimeout">
   </process-type>
</ias-component>

14.4 OracleAS Integration BAM Attribute Descriptions

This section describes the attributes that are specific for OracleAS Integration BAM.

The OracleAS Integration BAM attributes are described with the following format:

Title: This is the attribute name and value being defined. For example, id="BAM".
Required: This field defines whether or not the attribute is required in the component definition.
Default: This defines the default value assigned to the attribute. The default value appears in the installed version of the opmn.xml file or is assigned internally if the attribute is not present.
Valid values: This field defines the valid values for the attribute. For example, BAM.
Path: This field defines in which elements the attribute can appear. For example, ias-component.

id= BAM

Required: true
Default: none
Valid values: BAM
Path: ias-component

This id is required and cannot be changed. The id name must match the targets.xml entry or Application Server Control Console will not work.

id="BAM_PROPERTIES_FILE"

Required: true
Default: none
Path: ias-component/environment

This environment variable defines the full path to the bam.properties file.

module-id="BAMEngine"

Required: true
Default: none
Valid values: BAMEngine
Path: ias-component

This id is required and should not be changed to anything else.

id="TNS_INSTANCE"

Required: true
Valid values: Unique string name
Path: ias-component/environment

This environmental variable is required for OracleAS Integration BAM services.

id="LD_LIBRARY_PATH"

Required: true
Default: none
Path: ias-component/environment

This environment variable is required by OracleAS Integration BAM binaries to find their respective libraries.

id="bin_path"

Required: true
Default: none
Path: ias-component/process-type/module-data/category
Path: ias-component/process-type/process-set/module-data/category

This element must contain the full path (including the executable) to the process that starts the OracleAS Integration BAM engine.

category id="start-parameters"

Required: false
Default: none
Path: ias-component/module-data/category
Path: ias-component/process-type/module-data/category
Path: ias-component/process-type/process-set/module-data/category

This element indicates the configuration block for the start-parameters category. In this category, data associated with the stop module can be specified.

category id="stop-parameters"

Required: false
Default: none
Path: ias-component/module-data/category
Path: ias-component/process-type/module-data/category
Path: ias-component/process-type/process-set/module-data/category

This element indicates the configuration block for the stop-parameters category. In this category, data associated with the stop module can be specified.

module id="Monitor Framework"

Required: true
Default: none
Valid values: MonitorFramework
Path: ias-component/process-type

This id defines the type of process and associates the configuration with a process module.

data id="java-bin"

Required: false
Default: $ORACLE_HOME/jdk/bin/java
Valid values: Any full file path to a java executable file
Path: ias-component/module-data/category/data
Path: ias-component/process-type/module-data/category/data
Path:ias-component/process-type/process-set/module-data/category/
data

You can specify alternate paths to the java executable. However, a valid version of java will have to be used for the process to start up and work correctly. Oracle recommends JDK 1.4.1 or above.

data id="java-parameters"

Required: false
Default: none
Valid values: "-ms8m -mx512m" or any other valid java parameters
Path: ias-component/module-data/category/data
Path: ias-component/process-type/module-data/category/data
Path:ias-component/process-type/process-set/module-data/category/
data

You can specify any valid java parameters in the command line or replace existing default parameters using the default parameters list.

data id="class-name"

Required: false
Default: oracle.tip.bam.runtime.ProcessManager
Valid values: A valid java class name to start/stop BAM MonitorFramework
Path: ias-component/module-data/category/data
Path: ias-component/process-type/module-data/category/data
Path:ias-component/process-type/process-set/module-data/category/
data

You can specify the java class name which will be used for starting or stopping the OracleAS Integration BAM monitor framework process.

data id="application-parameters"

Required: false
Default: "MonitorFramework start" or "MonitorFramework stop"
Valid values: Valid application parameters
Path: ias-component/module-data/category/data
Path: ias-component/process-type/module-data/category/data
Path:ias-component/process-type/process-set/module-data/category/
data

You can specify valid application parameters which will be used for starting or stopping the OracleAS Integration BAM monitor framework processes.

data id="stop-option"

Required: false
Default: none
Valid values: force
Path: ias-component/module-data/category/data
Path: ias-component/process-type/module-data/category/data
Path:ias-component/process-type/process-set/module-data/category/
data

You can specify a valid stop option to force MonitorFramework to shutdown immediately without sending events to the repository.

process-set id="mf_instance1"

Required: true
Default: none
Valid values: A process instance name, for example "MonitorFramework".
Path: ias-component/process-type/process-set

This parameter is to tell the process instance name for this process-set. This instance name will be passed into OracleAS Integration BAM management class for starting or stopping Monitor Framework.

numprocs="1"

Required: true
Default: none
Valid values: 1
Path: ias-component/process-type/process-set

This attribute specifies the number of the instances started for this process set. OracleAS Integration BAM currently only enables you to start one instance with the same process type.

stop timeout="MyStopTimeout"

Required: false
Default: 60
Valid values: Any valid timeout in seconds.
Path: ias-component/process-type/

This parameter is to give a timeout in seconds before opmn hard kill the Monitor Framework process. A longer timeout enables Monitor Framework to flush the buffered events into repository.