10 Configuring Oracle Application Server Reports Services

This chapter describes Oracle Application Server Reports Services (OracleAS Reports Services) configuration in the OPMN opmn.xml file. The OracleAS Reports Services module manges the Reports Server and Reports Bridge processes.

It features the following topics:

Section 10.1, "Introduction"
Section 10.2, "OracleAS Reports Services Process Module Configuration"
Section 10.3, "Reports Server Minimum Configuration"
Section 10.4, "Reports Server Full Configuration"
Section 10.7, "OracleAS Reports Services Attribute Descriptions"

10.1 Introduction

This following sections describe the processes that the OracleAS Reports Services module manages:

Section 10.1.1, "Reports Server"
Section 10.1.2, "Reports Bridge"

10.1.1 Reports Server

The Reports Server can run in two modes:

in-process
standalone

The in-process server runs inside an OC4J instance and is managed by the OC4J module. In this mode, the OracleAS Reports Services module does not have to be configured. The OracleAS Reports Services server configuration is part of the OC4J instance configuration and is handled by the OC4J module.

The standalone OracleAS Reports Services server is managed by the OracleAS Reports Services module. The OracleAS Reports Services process module must be configured as shown in the Section 10.2, "OracleAS Reports Services Process Module Configuration".

10.1.2 Reports Bridge

Reports Bridge is a service used by OracleAS Reports Services clients to locate a Reports Server running in a remote subnet.

10.2 OracleAS Reports Services Process Module Configuration

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

<module path="$ORACLE_HOME/opmn/lib/libopmnreports.so">
   <module-id id="ReportsServices" />
   <module-id id="ReportsBridgeServices" />
</module>

10.3 Reports Server Minimum Configuration

This section describes the minimum configuration for Reports Server. It features the following topics:

Section 10.3.1, "In-process Reports Server Minimum Configuration"
Section 10.3.2, "Standalone Reports Server Minimum Configuration"

10.3.1 In-process Reports Server Minimum Configuration

The following example shows the minimum configuration required for the in-process Reports Server server. The lines should be placed within the configuration for the appropriate OC4J instance. The configuration directives are handled by the OC4J module.

<ias-component ....>
   <process-type ....>
      <module-data>
         <category id="urlping-parameters">
            <data id="/reports/rwservlet/pingserver?start=auto" value="200"/>
         </category>
      </module-data>
      <process-set .../>
   </process-type>
</ias-component>

10.3.2 Standalone Reports Server Minimum Configuration

The following example represents the minimum configuration for a standalone Reports Server component. Reasonable default values are assigned to all other configuration elements and attributes that can be used with this component.

<ias-component id="ReportsServer1">
   <process-type id="ReportsServer1" module-id="ReportsServices">
      <process-set id="ReportsServer1" numprocs="1">
         <environment>
            <variable id="PATH" value="Put Path_value from env here" append="true"/>
            <variable id="LD_LIBRARY_PATH" value="Put LD_Library_Path_value from env here"
             append="true"/>
         </environment>
      </process-set>
   </process-type>
</ias-component>

10.4 Reports Server Full Configuration

The following example represents the full configuration for Reports Server. It contains all possible configuration elements and attributes that can be used with this component. This section features the following topics:

Section 10.4.1, "In-process Reports Server Full Configuration"
Section 10.4.2, "Standalone Reports Server Full Configuration"

10.4.1 In-process Reports Server Full Configuration

The following example shows the full configuration required for the in-process Reports Server. The lines should be placed within the configuration for the appropriate OC4J instance. The configuration directives are handled by the OC4J module.

<ias-component ....>
   <process-type ....>
      <module-data>
         <category id="urlping-parameters">
            <data id="/reports/rwservlet/pingserver?start=auto" value="200"/>
         </category>
      </module-data>
      <process-set .../>
   </process-type>
</ias-component>

10.4.2 Standalone Reports Server Full Configuration

The following example shows the full configuration required for the standalone Reports Server.

<ias-component id="ReportsServer1" status="enabled" id-matching="false">
   <process-type id="ReportsServer1" module-id="ReportsServices">
      <process-set id="ReportsServer1" restart-on-death="true" numprocs="1">
      <environment>
         <variable id="PATH" value="Put Path_value here" append="true"/>
         <variable id="LD_LIBRARY_PATH" value="Put LD_Library_Path_value here" append="true">
      </environment>
      <module-data>
         <category id="general-parameters">
            <data id="batch" value="yes"/>
         </category>
         <category id="restart-parameters">
            <data id="reverseping-timeout"value="300"/>
         </category>
      </module-data>
      <start timeout="300" retry="3"/>
      <stop timeout="300"/>
      <restart timeout="300"/>
      <ping timeout="30" interval="30"/>
      </process-set>
   </process-type>
</ias-component>

10.5 Reports Bridge Minimum Configuration

The following example represents the minimum configuration for a standalone Reports Bridge component. Reasonable default values are assigned to all other configuration elements and attributes that can be used with this component.

<ias-component id="RWBridge" status="enabled" id-matching="false">
   <process-type id="ReportsBridge" module-id="ReportsBridgeServices">
      <process-set id="RWBridge" restart-on-death="true" numprocs="1">
         <environment>
            <variable id="PATH" value="$ORACLE_HOME/jdk/jre/bin" append="true"/>
            <variable id="PATH" value="Put Path_value from env here" append="true"/>
            <variable id="CLASSPATH" value="$ORACLE_HOME/jlib/zrclient.jar" append="true"/>
            <variable id="CLASSPATH" value="$ORACLE_HOME/reports/jlib/rwrun.jar" append="true"/>
         </environment>
      </process-set>
   </process-type>
</ias-component>

10.6 Reports Bridge Full Configuration

The following example represents the full configuration for a Reports Bridge component. Reasonable default values are assigned to all other configuration elements and attributes that can be used with this component.

<ias-component id="RWBridge" status="enabled" id-matching="false">
   <process-type id="ReportsBridge" module-id="ReportsBridgeServices">
      <process-set id="RWBridge" restart-on-death="true" numprocs="1">
         <environment>
            <variable id="PATH" value="$ORACLE_HOME/jdk/jre/bin" append="true"/>
            <variable  id="PATH" value="Put Path_value here" append="true"/>
            <variable id="CLASSPATH" value="$ORACLE_HOME/jlib/zrclient.jar" append="true"/>
            <variable id="CLASSPATH" value="$ORACLE_HOME/reports/jlib/rwrun.jar" append="true"/>
         </environment>
         <module-data>
            <category id="restart-parameters">
               <data id="reverseping-timeout" value="120"/>
            </category>
            <category id="start-parameters">
               <data id="jvm-options" value="-Xms128mb -Xmx256mb"/>
               <data id="bridge-options" value="Test"/>
            </category>
            <category id="stop-parameters">
               <data id="jvm-options" value="-Xms128mb -Xmx256mb"/>
               <data id="bridge-options" value="Test"/>
            </category>
         </module-data>
         <start timeout="120" retry="3"/>
         <stop timeout="120"/>
         <restart timeout="120" retry="0"/>
      </process-set>
   </process-type> 
</ias-component>

10.7 OracleAS Reports Services Attribute Descriptions

This section describes the attributes that are specific for OracleAS Reports Services.

The OracleAS Reports Services attributes are described with the following format:

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

id="ReportsServer1"

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

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

id="RWBridge"

Required: true
Default: none
Valid values: A string
Path: ias-component

A string can be specified as the name of the bridge.

process-type id="ReportsBridge"

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

This id is required and cannot be changed.

process-set id="RWBridge"

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

A string can be specified as the name of the bridge. The name must have the same value as specified in the id for the ias-component.

module-id="ReportsServices"

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

This module-id defines the type of process and associates this configuration with the OracleAS Reports Services process module. This module-id is specified when the OracleAS Reports Services module is used to control the Reports Server.

module-id="ReportsBridgeServices"

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

This id defines the type of process and associates the configuration with the OracleAS Reports Services process module. This id is used when the OracleAS Reports Services module is used to control the Reports Bridge services.

numprocs="1"

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

This attribute gives the number of OracleAS Reports Services servers started for the process-set. Its value has to be 1 because the process-set id identifies the OracleAS Reports Services server.

id="PATH"

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

This is the PATH environment variable set for the OracleAS Reports Services process.

value="Put Path_value here"

Required: true
Default: none
Valid values: The path value has to include the directory containing the uname command.
Path: ias-component/process-type/process-set/environment/
variable

This is the value of the PATH environment variable set for the OracleAS Reports Services process. This variable has to be set for the start script to find "uname".

id="general-parameters"

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

This category collects all the data that is common to the various process management tasks.

id="batch"

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

This id is used to construct the command line for starting and stopping of the OracleAS Reports Services server. The information is passed through to OracleAS Reports Services, without interpretation or use by OPMN. If it is not configured, this argument is not passed in.