10 Configuring Oracle Application Server Reports Services

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.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"

<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>

<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"

<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>

<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"

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"

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

process-type id="ReportsBridge"

This id is required and cannot be changed.

process-set id="RWBridge"

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"

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"

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"

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"

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

value="Put Path_value here"

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"

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

id="batch"

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.

id="restart-parameters"

The restart-parameters category for defines parameters used in death detection.

id="reverseping-timeout"

If OPMN does not receive a notification within the last reverseping-timeout period, it restarts the process.

id="urlping-parameters"

This id is a category that collects all the URLs that will be pinged by the OC4J module. The protocol used for pinging is AJPv1.3.

id="/reports/rwservlet/pingserver?start=auto"

This data id specifies the URL that will be pinged by the OC4J module. In the context of the in-process OracleAS Reports Services server, pinging this URL allows OPMN to determine if the OracleAS Reports Services server application is responsive or not. If the application is unresponsive, OPMN restarts the corresponding OC4J process.

value="200"

The value specifies a valid HTTP code that is expected in response to the ping request. If the response HTTP code matches the value configured here, OPMN considers the application to be valid. Otherwise, OPMN restarts the OC4J process.

id="start-parameters"

The start-parameters category is used for defining parameters that will be used in starting Reports Bridge.

id="stop-parameters"

The stop-parameters category is used for defining parameters that will be used in stopping the Reports Bridge.

id="jvm-options"

The jvm-options are supplied to the JVM while starting or stopping the Reports Bridge.

id="bridge-options"

The bridge-options are passed on to the Reports Bridge during starting and stopping. These can be any custom command line options that are supported for starting and stopping the Reports Bridge.

id="CLASSPATH"

The CLASSPATH value must point to $ORACLE_HOME/jlib/zrclient.jar and $ORACLE_HOME/reports/jlib/rwrun.jar. The classes required for running the Reports Bridge are available in these .jar files.