13 Configuring Oracle Application Server Discoverer

This chapter describes Oracle Application Server Discoverer (OracleAS Discoverer) configuration in the OPMN opmn.xml file.

It features the following topics:

OracleAS Discoverer Process Module Configuration
OracleAS Discoverer Minimum Configuration
OracleAS Discoverer Complete Configuration
OracleAS Discoverer Attribute Descriptions

13.1 OracleAS Discoverer Process Module Configuration

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

<module path="$ORACLE_HOME/opmn/lib/libopmndisco.so" cron="900">
   <module-id id="Disco_OSAgent"/>
   <module-id id="Disco_OAD"/>
   <module-id id="Disco_PreferenceServer"/>
</module>

13.2 OracleAS Discoverer Minimum Configuration

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

<ias-component id="Discoverer">
   <environment>
      <variable id="VBROKER_HOME" value="$ORACLE_HOME/vbroker4"/>
      <variable id="VBROKER_DIR" value="$ORACLE_HOME/vbroker4/bin"/>
      <variable id="OSAGENT_PORT" value="16001"/>
      <variable id="DISCO_DIR" value="$ORACLE_HOME/discoverer904"/>
      <variable id="DISCO_JRE" value="$ORACLE_HOME/jdk/jre"/>
      <variable id="DISCO_PREFERENCE" value="pdsun-dev12OracleDiscovererPreferences902"/>
      <variable id="LD_LIBRARY_PATH" value="$DISCO_DIR/lib:$VBROKER_DIR/lib: $ORACLE_HOME/lib"       append="true"/>
   </environment>
   <process-type id="OSAgent" module-id="Disco_OSAgent" working-dir= "$DISCO_DIR/util">
      <process-set id="OSAgent" numprocs="1"/>
   </process-type>
   <process-type id="OAD" module-id="Disco_OAD" working-dir="$DISCO_DIR/util">
      <process-set id="OAD" numprocs="1"/>
   </process-type>
   <process-type id="PreferenceServer" module-id="Disco_PreferenceServer" working-dir=    "$DISCO_DIR/util">
      <process-set id="PreferenceServer" numprocs="1"/>
   </process-type>
</ias-component>

13.3 OracleAS Discoverer Complete Configuration

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

<ias-component id="Discoverer">
   <environment>
      <variable id="VBROKER_HOME" value="$ORACLE_HOME/vbroker4"/>
      <variable id="VBROKER_DIR" value="$ORACLE_HOME/vbroker4/bin"/>
      <variable id="OSAGENT_PORT" value="16001"/>
      <variable id="DISCO_DIR" value="$ORACLE_HOME/discoverer904"/>
      <variable id="DISCO_JRE" value="$ORACLE_HOME/jdk/jre"/>
      <variable id="DISCO_PREFERENCE" value="pdsun-dev12OracleDiscoverer Preferences902"/>
      <variable id="LD_LIBRARY_PATH" value="$DISCO_DIR/lib:$VBROKER_DIR/lib:$ORACLE_HOME/lib"       append="true"/>
   </environment>
   <process-type id="OSAgent" module-id="Disco_OSAgent" working-dir="$DISCO_DIR/util">
      <ping interval="300"/>
   <process-set id="OSAgent" numprocs="1"/>
      <module-data>
         <category id="start-parameters">
            <data id="osagent-options" value="osagent-options_value"/>
            <data id="osagent-extra-options" value="osagent-extra-options"/>
         </category>
         <category id="ping-parameters">
            <data id="osfind-options" value="osfind-options_value"/>
            <data id="osfind-java-options" value="osfind-java-options_value"/>
            <data id="osfind-extra-options" value="osfind-extra-options_value"/>
         </category>
      </module-data>
   </process-type>
   <process-type id="OAD" module-id="Disco_OAD" working-dir="$DISCO_DIR/util">
      <start timeout="180"/>
   <process-set id="OAD" numprocs="1"/>
      <module-data>
         <category id="start-parameters">
            <data id="oad-options" value="oad-options_value"/>
            <data id="oad-java-options" value="oad-java-options_value"/>
            <data id="oad-extra-options" value="oad-extra-options_value"/>
         </category>
         <category id="ping-parameters">
            <data id="oadutil-options" value="oadutil-options_value"/>
            <data id="oadutil-java-options" value="oadutil-java-options_value"/>
            <data id="oadutil-extra-options" value="oadutil-extra-options_value"/>
         </category>
         <category id="sessionserver-parameters"">
            <data id="shutdown-event-name" value="shutdown-event-name_value"/>
            <data id="reverse-ping-interval" value="interval-value"/>
         </category>
         <category id="bounce-parameters">
            <data id="bounce-process" value="true"/>
            <data id="bounce-time" value="01:00"/>
         </category>
      </module-data>
   </process-type>
   <process-type id="PreferenceServer" module-id="Disco_PreferenceServer" 
   working-dir="$DISCO_DIR/util">
   <process-set id="PreferenceServer" numprocs="1"/>
      <module-data>
         <category id="start-parameters">
            <data id="dis51pr-options" value="dis51pr-options_value"/>
            <data id="dis51pr-extra-options" value="dis51pr-extra-options_value"/>
         </category>
      </module-data>
   </process-type>
</ias-component>

13.4 OracleAS Discoverer Attribute Descriptions

This section describes the attributes that are specific for OracleAS Discoverer.

The OracleAS Discoverer attributes are described with the following format:

Title: This is the attribute name and value being defined. For example, id="Discoverer".
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, Discoverer.
Path: This field defines in which elements the attribute can appear. For example, ias-component.

id="Discoverer"

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

This id is required and cannot be changed. The name must match the targets.xml entry or elements and attributes will not work.

id="VBROKER_HOME"

Required: true
Default: $ORACLE_HOME/vbroker4
Path: ias-component/environment/variable

OPMN depends on this environment variable to locate the binaries and libraries of vbroker. This element gives you the flexibility to point to the vbroker directory that is different from $ORACLE_HOME/vbroker4.

id="VBROKER_DIR"

Required: true
Default: $ORACLE_HOME/vbroker4/bin
Path: ias-component/environment/variable

Visibroker depends on this environment variable to locate the binaries of vbroker.

id="OSAGENT_PORT"

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

This environment variable is required for all the OracleAS Discoverer components to talk to each other.

id="DISCO_DIR"

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

This environment variable is required for OPMN to locate the binaries and libraries of OracleAS Discoverer components, such as dis51pr.

id="DISCO_JRE"

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

This environment variable is used by OPMN to locate the JRE location used to start the Object Activation Daemon (OAD). This element gives you the flexibility to point to the JRE directory other than the one under $ORACLE_HOME.

id="DISCO_PREFERENCE"

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

This environment variable defines the preference instance name for the preference server.

id="LD_LIBRARY_PATH"

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

This environment variable is required for OracleAS Discoverer binaries to find the libraries.

Three directories are required:

$DISCO_DIR/lib
$VBROKER_DIR/lib
$ORACLE_HOME/lib

id="OSAgent"

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

This id is required and cannot be changed. The id must match the targets.xml entry or elements and attributes will not work.

module-id="Disco_OSAgent"

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

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

working-dir="$DISCO_DIR/util"

Required: true
Default: none
Valid values: $DISCO_DIR/util
Path: ias-component/process-type

This attribute specifies where the log file associated with the osagent process will exist.

interval="300"

Required: false
Default: 20 seconds
Valid values: >= 0
Path: ias-component/process-type/ping

Please refer to the common configuration for a full list of attributes for the ping element. The above example shows how to specify a ping interval to ping your process every 5 minutes.

numprocs="1"

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

This attribute gives the number of osagent instances started for this process-set. There should be at most one instance running in one Oracle Application Server instance.

id="start-parameters"

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

This is the category to specify the startup parameters for osagent.

id="osagent-options"

Required: false
Default: Refer to the following paragraph.
Path: ias-component/process-type/process-set/module-data/
category/data

The default option for $ORACLE_HOME/vbroker4/bin/osagent is:

"-p $OSAGENT_PORT"

You can overwrite this default option by specifying a valid value for this element.

id="osagent-extra-options"

Required: false
Default: Refer to the following paragraph.
Path: ias-component/process-type/process-set/module-data/
category/data

You can specify extra options for the default option for "-p $OSAGENT_PORT" for the osagent-options parameter. If the osagent-options parameter is specified then this id is ignored.

id="ping-parameters"

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

This is the category to specify the ping parameters for osagent.

id="osfind-options"

Required: false
Default: Refer to the following paragraph.
Path: ias-component/process-type/process-set/module-data/
category/data

osfind is a Java program. The base class is com.inpriese.vbroker.ds.OSFind. The default option is none and the default Java option is:

-Xbootclasspath/p:$VBROKER_HOME/lib/vbjorb.jar -Dvbroker.agemt.port=$OSAGENT_PORT"

You can overwrite this default option by specifying a valid value for this element.

id="osfind-java-options"

Required: false
Default: Refer to the following paragraph.
Path: ias-component/process-type/process-set/module-data/
category/data

You can specify extra Java options to the default Java option of:

-Xbootclasspath/p:$VBROKER_HOME/lib/vbjorb.jar -Dvbroker.agemt.port=$OSAGENT_PORT"

If osagent-options is specified, this element is ignored.

id="osfind-extra-options"

Required: false
Default: Refer to the following paragraph.
Path: ias-component/process-type/process-set/module-data/
category/data

You can specify extra options to the default option of:

-Xbootclasspath/p:$VBROKER_HOME/lib/vbjorb.jar -Dvbroker.agemt.port=$OSAGENT_PORT"

If osagent-options is specified, this element is ignored.

id="OAD"

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

This name is required and cannot be changed. The name must match the targets.xml entry or elements and attributes will not work.

module-id="Disco_OAD"

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

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

working-dir="$DISCO_DIR/util"

Required: true
Default: none
Valid values: $DISCO_DIR/util
Path: ias-component/process-type
Path: ias-component/process-type/process-set

This attribute specifies where the log file associated with the OAD process will exist.

timeout="180"

Required: false
Default: 120 seconds
Valid values: >= 0
Path: ias-component/process-type/start

Please refer to the Chapter 4, "opmn.xml Common Configuration" for a full list of attributes for the <> element. OAD is a Java process which may take additional time to just start. Use this attribute to adjust it.

numprocs="1"

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

This attribute gives the number of OAD instances started for this process-set. There should be at most one OAD instance running in one Oracle Application Server instance.

id="start-parameters"

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

This is the category to specify the startup parameters for OAD.

id="oad-options"

Required: false
Default: Refer to the following paragraph.
Path: ias-component/process-type/process-set/module-data/
category/data

oad is a Java program. The base class is com.inprise.vbroker.activationImpl.OADserv. The default option for $ORACLE_HOME/vbroker4/bin/oad is:

-Xbootclasspath:$VBROKER_DIR/lib/vbjorb.jar
-Dvbroker.agent.port=$OSAGENT_PORT
-Dvbroker.se.iiop_tp.scm.iiop_tp.listener.port=0 -DJDKrenameBug=true
-Dvbroker.oad.path=\"\" -Dvbroker.orb.admDir=$VBROKER_ADM
(For Windows only(-Dvbroker.oad.systemRoot=$SystemRoot ))
-Dorg.omg.CORBA.ORBClass=com.inprise.vbroker.orb.ORB
-Dorg.omg.CORBA.ORBSingletonClass=com.inprise.vbroker.orb.ORBSingleton
-cp $VBROKER_DIR/lib/vbjorb.jar

The default option is:

"-path $VBROKER_ADM"

You can overwrite this default option by specify a valid value for this element.

id="oad-java-options"

Required: false
Default: Refer to the following paragraph.
Path: ias-component/process-type/process-set/module-data/
category/data

The default option is:

"-path $VBROKER_ADM"

You can specify extra Java options to the default option. If oad-options is specified, this element is ignored.

id="oad-extra-options"

Required: false
Default: Refer to the following paragraph.
Path: ias-component/process-type/process-set/module-data/
category/data

The default option is:

"-path $VBROKER_ADM"

You can specify extra options to the default option. If oad-options is specified, this element is ignored.

id="ping-parameters"

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

This is the category to specify the ping parameters for OAD.

id="oadutil-options"

Required: false
Default: Refer to the following paragraph.
Path: ias-component/process-type/process-set/module-data/
category/data

oadutil is a Java program. The base class is com.inprise.vbroker.activationImpl.OADutil. The default Java option is:

-xbootclasspath/p:$VBROKER_HOME/lib/vbjorb.jar -Dvbroker.agent.port=$OSAGENT_PORT"

The default option is:

"list"

You can overwrite this default option by specify a valid value for this element.

id="oadutil-java-options"

Required: false
Default: Refer to the following paragraph.
Path: ias-component/process-type/process-set/module-data/
category/data

The default Java option for is:

-xbootclasspath/p:$VBROKER_HOME/lib/vbjorb.jar -Dvbroker.agent.port=$OSAGENT_PORT"

The default option is:

"list"

You can specify extra Java options to the default option. If oadutil-options is specified, this element is ignored.

id="oadutil-extra-options"

Required: false
Default: Refer to the following paragraph.
Path: ias-component/process-type/process-set/module-data/
category/data

The default Java option for is:

-xbootclasspath/p:$VBROKER_HOME/lib/vbjorb.jar -Dvbroker.agent.port=$OSAGENT_PORT"

The default option is:

"list"

You can specify extra options to the default option. If oadutil-options is specified, this element is ignored.

id="sessionserver-parameters"

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

This is the category to specify the parameters for the session servers started by OAD.

The session server is a OracleAS Discoverer process that is launched during a user session. The OracleAS Discoverer session server performs such operations as connecting to a database or opening a workbook. The session server provides the link between the OracleAS Discoverer servlet or applet to the database.

id="shutdown-event-name"

Required: false
Default: $ORACLE_HOME/opmn/bin/opmn
Valid values: Any existing file
Path: ias-component/process-type/process-set/module-data/
category/data

Shutdown-event-name is used to create either a semaphore on Unix, or an event on Windows in order to coordinate the shutdown of OAD and the session servers. On Unix, it must point to an existing file. If the file does not exist, OPMN will throw an error and disable the whole module.

Oracle does not recommend changing this value.

id="reverse-ping-interval"

Required: false
Default: 300 (in seconds)
Valid values: any value > 0
Path: ias-component/process-type/process-set/module-data/
category/data

Session servers will send reverse ping notifications to OPMN periodically. This id sets the interval of the pinging. The default interval is five minutes. If session server crashes, no more notifications are sent to OPMN. OPMN will remove the entry for this server from the DMS tree if two consecutive notifications are missing from a server. If you modify this value, you should also modify the argument to start the session server accordingly.

id="bounce-parameters"

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

This is the category to specify the bounce parameters for OAD. OAD can be scheduled for restart every day for a specific time period. It must run for 24 hours prior to schedule set-up.

id="bounce-process"

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

Set this data to true and OAD will be restarted as scheduled.

id="bounce-time"

Required: false
Default: none
Valid values: any value in the format of 00:00 (hour:minute) on a 24-hour base.
Path: ias-component/process-type/process-set/module-data/
category/data

id="PreferenceServer"

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

This name is required and cannot be changed. The name must match the entry in the targets.xml file or elements and attributes will not work.

module-id="Disco_PreferenceServer"

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

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

working-dir="$DISCO_DIR/util"

Required: true
Default: none
Valid values: $DISCO_DIR/util
Path: ias-component/process-type

This attribute specifies the location of the log file associated with the dis51pr process.

numprocs="1"

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

This attribute gives the number of preference server instances started for the process-set. There should be at most one instance running in one Oracle Application Server instance.

id="start-parameters"

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

This is the category to specify the startup parameters for dis51pr.

id="dis51pr-options"

Required: false
Default: Refer to the following paragraph.
Path: ias-component/process-type/process-set/module-data/
category/data

The default option for $DISCO_DIR/bin/dis51pr is:

"-ORBagentPort $OSAGENT_PORT -preference $DISCO_PREFERENCE -U"

You can overwrite this default option by specifying a valid value for this element.

id="dis51pr-extra-options"

Required: false
Default: Refer to the following paragraph.
Path: ias-component/process-type/process-set/module-data/
category/data

The default option for $DISCO_DIR/bin/dis51pr is:

"-ORBagentPort $OSAGENT_PORT -preference $DISCO_PREFERENCE -U"

You can specify extra options to the listed default option. If dis51pr-options is specified, this element is ignored.