E Advanced Configuration Reference

This appendix provides advanced postinstallation configuration and administration procedures that are not specific to analyses, agents, dashboards, or the Oracle BI Presentation Catalog. Directions for configuring these components of Oracle Business Intelligence are in earlier chapters. Most administrators need not change the configuration settings that are described in this appendix.

This appendix contains the following topics:

E.1 Making Advanced Configuration Changes for Oracle BI Presentation Services

The Oracle BI Presentation Services process hosts most of the business logic of the Web server and provides the framework and interface for the presentation of business intelligence data to Web clients.

  • Under Windows, the process is sawserver.exe

  • Under UNIX, the process is sawserver

The instanceconfig.xml file stores the configuration settings that affect Oracle BI Presentation Services. Many configuration settings are available in Fusion Middleware Control and that is the preferred method for making configuration changes. If a particular settings is not available in Fusion Middleware Control, then you can change it using the instanceconfig.xml file. You should make changes directly in this file only to change default elements, such as the name of the Oracle BI Presentation Catalog, or override internal default settings, such as those related to caches.

Several entries are present in the instanceconfig.xml file by default, including the path to the Oracle BI Presentation Catalog, and the name of the Oracle Business Intelligence Server data source name used by Presentation Services to access Oracle BI Server.

Note:

If you have previously made configuration changes by modifying the Windows registry, then you should migrate those changes to the instanceconfig.xml. In the Windows registry, entries under the Common key remain valid.

You can use the instanceconfig.xml file to customize various aspects of your deployment. For additional customization options that you can make in XML files for Presentation Services, see Section 22.5, "Customizing the User Interface Using XML Message Files."

The following procedure provides information on general configuration changes that you can make. Before you begin this procedure, ensure that you are familiar with the information in Section 3.4, "Using a Text Editor to Update Oracle Business Intelligence Configuration Settings".

To manually edit the settings for general configuration changes:

  1. Open the instanceconfig.xml file for editing, as described in Section 3.6, "Where are Configuration Files Located?"

  2. Locate the section in which you must add the elements that are described in Table E-1.

  3. Include the elements and their ancestor elements as appropriate, as shown in the following example:

    <ServerInstance>
      <CaseInsensitiveMode>False</CaseInsensitiveMode>
      <UnaccessedRunningTimeoutMinutes>5</UnaccessedRunningTimeoutMinutes>
      <Security>
        <AllowRememberPassword>False</AllowRememberPassword>
        <CookieDomain>value</CookieDomain>
        <CookiePath>/analytics</CookiePath>
        <HardenXSS>true</HardenXSS>
      </Security>
    </ServerInstance>
    
  4. Save your changes and close the file.

  5. Restart Oracle Business Intelligence.

Table E-1 Elements for General Configuration

Element Description Default Value

AllowRememberPassword

Specifies whether to allow the browser to save the password, using browser-specific password management software. If set to true, prompts the user to specify whether to save the password for future sign-ins.

False

CaseInsensitiveMode

Specifies whether to use case sensitivity when performing tasks in Presentation Services that relate to case, such as sorting.

The BI Server has the CASE_SENSITIVE_CHARACTER_COMPARISON parameter that controls whether the BI Server uses case-sensitivity. You should ensure that Presentation Services has the same case-sensitivity setting as the BI Server. To do so, set the CaseInsensitiveMode element to the corresponding value. If the values do not correspond, then you might see inconsistent results in operations such as sorting.

For example, if CASE_SENSITIVE_CHARACTER_COMPARISON is set to On, then set CaseInsensitiveMode to its default value of False so that case-sensitivity is enabled in both places.

For more information, see Section A.4.4, "CASE_SENSITIVE_CHARACTER_COMPARISON."

False

CookieDomain

Specifies domain information for a cookie that is sent to the browser.

NA

CookiePath

Specifies the domain path to which cookies apply.

/analytics

HardenXSS

For a description, see Section E.1.1, "HardenXSS Element."

True

UnaccessedRunningTimeoutMinutes

Specifies the time to elapse, in minutes, before an unattended analysis is canceled. An unattended analysis is one that has not been accessed in the number of minutes specified by this setting. The minimum value is 2.

This element addresses the case where a user is editing an analysis and browses elsewhere, abandoning the analysis, at least temporarily. Do not set the value too small, however, as the user might return to the analysis.

5


E.1.1 HardenXSS Element

You use the HardenXSS element to secure Presentation Services against cross-site scripting (XSS). Securing against XSS escapes input in fields in Presentation Services and renders it as plain text. For example, an unscrupulous user can use an HTML field to enter a script that steals data from a page.

By default, Presentation Services is secured against XSS, which means that users cannot save content that is flagged as HTML; instead only users who have the appropriate privileges can save content that contains HTML. In a default installation, only administrative users have the privileges to save content that is later rendered as HTML. Note that in a secure environment, only resources (images) that are located in Presentation Services can be used. These images are referenced using a relative path prefixed with "fmap:" (for example, fmap:images/someimage.gif) and cannot be retrieved using a full URL (for example, http://www.example.com/images/someimage.gif).

For information on privileges, see Section C.2.3, "Managing Presentation Services Privileges."

E.2 Using the JavaHost Service for Oracle BI Presentation Services

The JavaHost service gives Presentation Services the ability to use functionality that is provided in Java libraries to support the following components:

  • Graph generation

  • SVG renderer (Apache Batik)

  • Oracle BI Scheduler (Java tasks support)

  • Oracle BI Publisher

  • Advanced reporting

  • URL Connect (Issues an HTTP request to another component)

  • Integration Service Call (Used by the Oracle BI Server to execute Java code)

To configure the JavaHost service, you can manually edit the configuration elements for the service in its configuration file (config.xml), located in the ORACLE_INSTANCE\config\OracleBIJavaHostComponent\coreapplication_obijhn directory. See Table E-2 for a description of the elements. The elements are identified by their relative path starting from the JavaHost element.

The common sub-elements, such as InputStreamLimitInKB, do not apply to the MessageProcessor, Listener, or SSL loaders.

For information on manual editing, see Section 3.4, "Using a Text Editor to Update Oracle Business Intelligence Configuration Settings"

Table E-2 JavaHost Service Configuration Elements in config.xml

Element Description

Loaders

Contains the ListOfEnabledLoaders and Loader elements. These elements specify the components for the JavaHost service. Avoid editing the elements in the Loaders section.

Loaders/ListOfEnabledLoaders

Specifies the list of components (such as Oracle BI Scheduler and BI Publisher) to be enabled.

If this element is missing from the file, then all Loaders are enabled. If the element has an empty value, then all loaders are disabled.

Each component has a corresponding Loader element. The name of the component listed here must match the name that is specified in the corresponding Loader/Name element.

Loaders/Loader

Contains the following elements, which specify configuration information for a specific component:

  • Name

  • Class

  • ConfigNodePath

  • ClassPath

Loaders/Loader/Name

Specifies the unique name of the component. Use this name in the ListOfEnabledLoaders element.

Loaders/Loader/Class

Specifies the main class for the component.

Loaders/Loader/ConfigNodePath

Specifies the XPath (starting from the JavaHost element) to the configuration information for the Loader.

Loaders/Loader/ClassPath

Specifies the paths for the JAR files of libraries that the JavaHost service can use.

InputStreamLimitInKB

A sub-element common to each loader that specifies, in kilobytes, the maximum input size for requests that are sent to JavaHost. A value of zero deactivates this limit. If the maximum size is exceeded, then an error message is displayed.

Default: 8192

RequestResponseLogDirectory

A sub-element common to each loader that specifies the name of the directory for the response files of requests.

Default: A default temp directory

LogLargeRequests

A sub-element common to each loader that specifies whether to create a response file when processing large requests.

Default: True

ReadRequestBeforeProcessing

A sub-element common to each loader that specifies whether to wait to process the request until a file is completely read.

Default: True

LargeRequestThresholdInKB

A sub-element common to each loader that specifies, in kilobytes, the maximum size before using disk space for requests. For requests larger than this size, use disk space instead of memory to cache the requested data. The larger this value is the more memory that the JavaHost service might potentially use and the faster the request processing can occur. This setting also establishes the threshold for the LogLargeRequests element.

Default: 200

MessageProcessor

Contains the SocketTimeout element.

MessageProcessor/SocketTimeout

Specifies the idle timeout (in milliseconds) for the socket, after which the socket is returned to the idle sockets pool. JavaHost uses a socket polling mechanism to wait for new data on the whole set of idle sockets in a single thread. Initial messages in the idle pool are handled through Java NIO channels.

Default: 5000 (5 seconds)

Listener

Contains the following elements:

  • PermittedClientList

  • Port

  • Address

  • Secure

Listener/PermittedClientList

Specifies a list of IP addresses and host names from which JavaHost accepts incoming connections. Separate each client's IP address or host name by a comma. To accept all client connections, set this element to an asterisk (*).

Default: *

Listener/Port

Identifies the JavaHost TCP/IP listening port.

Default: 9810

Listener/Address

Specifies the network interface that JavaHost is to bind to. If this element has no value, then JavaHost binds to all available network interfaces.

Listener/Secure

Specifies whether to enable SSL encryption for the JavaHost service:

  • Yes: Enables SSL encryption

  • No: Disables SSL encryption

Default: No

For information on SSL, see Oracle Fusion Middleware Security Guide for Oracle Business Intelligence Enterprise Edition.

Batik

Contains only the common sub-elements such as InputStreamLimitInKB, as they relate to converting SVG graphics to rasterized image formats.

Scheduler

Contains the following elements:

  • Enabled

  • DefaultUserJarFilePath

  • DefaultTempFilePath

  • DefaultPurgingPeriod

Scheduler/Enabled

Specifies whether to enable the interaction of the JavaHost service with Oracle BI Scheduler:

  • True: Enables interaction with Oracle BI Scheduler

  • False: Disables interaction with Oracle BI Scheduler

Default: False

Scheduler/DefaultUserJarFilePath

Specifies the default directory for storing JAR files for the Java extension utility.

When Oracle BI Scheduler is enabled, this element is required and accepts a single path.

Scheduler/DefaultTempFilePath

Specifies the default directory for storing temporary files for Oracle BI Scheduler requests.

Default: the system temp directory

Scheduler/DefaultPurgingPeriod

Specifies the default period (in seconds) for Oracle BI Scheduler requests to clean up failed jobs.

Default: 300

XMLP

Contains only the common sub-elements such as InputStreamLimitInKB and ReadRequestBeforeProcessing, as they relate to Oracle BI Publisher.

URLConnect

Contains elements that relate to SSL. Avoid modifying these elements.

DVT

Contains only the common InputStreamLimitInKB sub-element by default, as they relate to graph generation. You can add other common sub-elements as necessary.