11 Configuring Oracle Business Intelligence Discoverer

This chapter describes Oracle Business Intelligence Discoverer (OracleBI Discoverer) configuration in the OPMN opmn.xml file.

It features the following topics:

Section 11.1, "OracleBI Discoverer Process Module Configuration"
Section 11.2, "OracleBI Discoverer Minimum Configuration"
Section 11.3, "OracleBI Discoverer Complete Configuration"
Section 11.4, "OracleBI Discoverer Attribute Descriptions"

11.1 OracleBI Discoverer Process Module Configuration

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

<module path="$ORACLE_HOME/opmn/lib/libopmndisco.so">
   <module-id id="Disco_ServicesStatus"/>
   <module-id id="Disco_SessionServer"/>
   <module-id id="Disco_PreferenceServer"/> 
</module>

11.2 OracleBI Discoverer Minimum Configuration

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

<ias-component id="Discoverer">
   <environment>
      <variable id="PREFERENCE_PORT" value="16001"/>
      <variable id="DISCO_DIR" value="$ORACLE_HOME/discoverer"/>
      <variable id="LD_LIBRARY_PATH" value="$DISCO_DIR/lib:$ORACLE_HOME/lib" append="true"/>
   </environment>
   <process-type id="SessionServer" module-id="Disco_SessionServer" >
      <port id="ses" range="3801-3950"/>
      <process-set id="SessionServer" minprocs="0" maxprocs=150 restart-on-death= "false"
       parallel-requests="true"/>
   </process-type>
   <process-type id="ServicesStatus" module-id="Disco_ServicesStatus">
      <process-set id="ServicesStatus" numprocs="1"/>
   </process-type>
   <process-type id="PreferenceServer" module-id="Disco_PreferenceServer">
      <process-set id="PreferenceServer" numprocs="1"/>
   </process-type>
</ias-component>

11.3 OracleBI Discoverer Complete Configuration

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

<ias-component id="Discoverer">
   <environment>
      <variable id="DISCO_DIR" value="$ORACLE_HOME/discoverer"/>
      <variable id="PREFERENCE_PORT" value="16001"/>
      <variable id="LD_LIBRARY_PATH" value="$DISCO_DIR/lib:$ORACLE_HOME/lib" append="true"/> 
   </environment>
   <process-type id="SessionServer" module-id="Disco_SessionServer">
      <ping interval="40"/>
      <port id="ses" range="3801-3950"/>
      <process-set id="SessionServer" minprocs="0" maxprocs="150" restart-on-death="false"
       parallel-requests="true"/>
         <module-data>
            <category id="start-parameters">
               <data id="dis51ws-options" value="dis51ws-options_value"/>
               <data id="dis51ws-extra-options" value="dis51ws-extra-options_value"/>
            </category>
         </module-data>
   </process-type>
   <process-type id="ServicesStatus" module-id="Disco_ServicesStatus"
      <process-set id="ServicesStatus" numprocs="1"/>
   </process-type>
   <process-type id="PreferenceServer" module-id="Disco_PreferenceServer" >
      <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>

11.4 OracleBI Discoverer Attribute Descriptions

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

The OracleBI 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: If applicable, 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 Application Server Control Console will not work.

id="DISCO_DIR"

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

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

id="PREFERENCE_PORT"

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

This environment variable defines the port for the preference server.

id="LD_LIBRARY_PATH"

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

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

The following directories are required:

$DISCO_DIR/lib
$ORACLE_HOME/lib

id="SessionServer"

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

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

module-id="Disco_SessionServer"

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

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

interval="40"

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 code example in Section 11.3, "OracleBI Discoverer Complete Configuration" shows a ping interval to ping a process every 40 seconds. Oracle recommends a 40 second ping interval for Session servers.

id="ses"

Required: false
Default: "ses"
Valid values: "ses"
Path: ias-component/process-type/port

Please refer to the common configuration for a full list of attributes for "port" element. "ses" is the port id under which the range of ports for the Session server is specified.

range="3801-3950"

Required: false
Default: 3801-3950
Valid values: >= 0
Path: ias-component/process-type/port

Please refer to the common configuration for a full list of attributes for "port" element. When configuring ports for the Session servers make sure there are enough ports; the number of ports should be equal to maxprocs.

minprocs="0"

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

This attribute gives the number of Session server instances started for this process-set. This should be set to zero so OPMN does not attempt to start the Session servers when a startproc command is executed on OracleBI Discoverer.

maxprocs="150"

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

This attribute gives the number of Session server instances started for this process-set. This should be configured such that the maximum number of processes does not exhaust computer resources.

restart-on-death="false"

Required: true
Default: true
Valid values: true, false
Path: ias-component/process-type/process-set

This attribute notifies OPMN whether to attempt to restart a process after it stops. For Session servers this should always be set to "false".

parallel-requests="true"

Required: false
Default: false
Valid values: true, false
Path: ias-component/process-type/process-set

This attribute notifies OPMN on how to handle incoming requests for this process-set. If set to true the requests will be handled in parallel. If set to false the requests will be handled serially.

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 Session servers.

id="dis51ws-options"

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

The default command line options for $DISCO_DIR/bin/dis51ws are:

prompt> "-opmn_ping_time <ping interval> -port <port> -preferencePort $PREFERENCE_PORT -uid <unique identifier>"

You can override these default options by specifying valid command line options for this element. The unique identifier (-uid) is added at the end of the command line. Make sure you include the -uid at the end of your specified options.

id="dis51ws-extra-options"

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

The default command line options for $DISCO_DIR/bin/dis51ws are:

prompt> "-opmn_ping_time <ping interval> -port <port> -preferencePort $PREFERENCE_PORT -uid <unique identifier>"

You can add to default options by specifying valid command line options for this element. If dis51ws-options is specified this element will be ignored.

id="ServicesStatus"

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

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

module-id="Disco_ServicesStatus"

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

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

numprocs="1"

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

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

id="PreferenceServer"

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

This id is required and cannot be changed. The name must match the targets.xml entry or Application Server Control Console 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 this configuration with a process module.

numprocs="1"

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

This attribute gives the number of Preference server 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 ping 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 command line option for $DISCO_DIR/bin/dis51pr is:

prompt> "-ORBEndpoint iiop://:$PREFERENCE_PORT -U <unique identifier>"

You can override the default option by specifying valid command line options for this element. The unique identifier (-U) is added to the end of the command line. Make sure to include -U at the end of your command option.

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 command line option for $DISCO_DIR/bin/dis51pr is:

prompt> "-ORBEndpoint iiop://:$PREFERENCE_PORT -U <unique identifier>"