12
Configuring OracleAS Reports Services

This chapter describes OracleAS Reports Services configuration in the OPMN opmn.xml file.

It features the following topics:

12.1 Introduction

The OracleAS Reports Services server can run in two modes:

in-process
standalone

The in-process OracleAS Reports Services 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 12.2, "OracleAS Reports Services Process Module Configuration". There is also an Oracle Application Server component configured to represent the standalone OracleAS Reports Services server.

12.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="/private/oraclehome/opmn/lib/libopmnreports.so">
   <module-id id="ReportsModule" />
</module>

12.3 OracleAS Reports Services Minimum Configuration

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

12.3.1 In-process OracleAS Reports Services Server

The following example shows the configuration required for the in-process OracleAS Reports Services 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>

12.3.2 Standalone OracleAS Reports Services Server

The following example represents the minimum configuration for a standalone OracleAS Reports Services 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="ReportsModule">
      <process-set id="ReportsServer1" numprocs="1">
         <environment>
            <variable id="PATH" value="Put Path_value from env here" append="true"/>
         </environment>
      </process-set>
   </process-type>
</ias-component>

12.4 OracleAS Reports Services Complete Configuration

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

12.4.1 In-process OracleAS Reports Services Server

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

12.4.2 Standalone OracleAS Reports Services Server

The following example shows the configuration required for the standalone OracleAS Reports Services server.

<ias-component id="ReportsServer1" status="enabled" id-matching="false">
   <process-type id="ReportsServer1" module-id="ReportsModule">
      <process-set id="ReportsServer1" restart-on-death="true" numprocs="1">
      <environment>
         <variable id ='PATH' value="Put 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>

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

module-id="ReportsModule"

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

This id defines the type of process and associates the configuration with the OracleAS Reports Services process module.

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.

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.

See Also:

Oracle Application Server Reports Services Publishing Reports to the Web

id="restart-parameters"

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

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

id="reverseping-timeout"

Required: false
Default: 300
Valid values: Any reasonable timeout value specified in seconds.
Path: ias-component/process-type/process-set/module-data/
category/data

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

id="urlping-parameters"

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

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"

Required: false
Default: none
Valid values: /reports/rwservlet/pingserver?start=auto
Path: ias-component/process-type/process-set/module-data/ category/data

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"

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

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.

12 Configuring OracleAS Reports Services