A OracleBI Discoverer configuration files

This appendix provides reference information about Discoverer configuration files, and contains the following topics:

Section A.1, "List of Discoverer file locations"
Section A.2, "List of configuration settings in configuration.xml"
Section A.3, "List of configuration settings in opmn.xml"

A.1 List of Discoverer file locations

This section lists the files that are used to configure and maintain OracleBI Discoverer. Many of the settings in the configuration files are configured using Application Server Control. Where possible, use Application Server Control to configure Discoverer. If you update settings in the configuration files manually, you must only do so in accordance with the instructions in this guide.

The table below shows the locations of these files on both UNIX and Windows platforms.

File name	Description and location
applypreferences.bat/.sh	This file updates the Discoverer Preferences component (Windows specific). On UNIX: <ORACLE_HOME>/discoverer/util/applypreferences.sh On Windows: <ORACLE_HOME>\discoverer\util\applypreferences.bat Hint: Information about processing errors are stored in error.txt (for more information, see File name entry for error.txt).
certdb.txt	This file contains the security certificate store for Oracle JInitiator, and is stored on each client machine that is running Discoverer Plus. On UNIX: <JINITIATOR HOME>/lib/security/certdb.txt On Windows: <JINITIATOR HOME>\lib\security\certdb.txt where <JINITIATOR HOME> is the location on the client machine in which JInitiator is installed (e.g. c:\program files\oracle\JInitiator 1.3.1.9\) For more information about installing a security certificate in the JInitiator certificate store, see Section 3.5.1, "How to install a security certificate on a Discoverer Plus client machine". For more information about certdb.txt, see Section 14.6.3.1, "About configuring Discoverer Plus for a non-standard SSL signing authority".
checkdiscoverer.bat/.sh	This file starts a utility that checks the configuration of the Discoverer middle tier, checks the status of the middle tier components, and reports any failures or anomalies. On UNIX: <ORACLE_HOME>/discoverer/util/checkdiscoverer.sh On Windows: <ORACLE_HOME>\discoverer\util\checkdiscoverer.bat Note: You can also find documentation on using the checkdiscoverer utility in the \util directory.
collectlogs.bat	This script file collects all Discoverer logs into a folder. On UNIX:<ORACLE_HOME>/discoverer/util/collectlogs.sh On Windows: <ORACLE_HOME>\discoverer\util\collectlogs.bat Note: For more information about using the collectlogs script, see Section D.2.9, "How to copy Discoverer log files".
configuration.xml	This file stores configuration settings for Discoverer. Note: Do not edit this file manually. Use the Discoverer Services Configuration page in Application Server Control to configure settings in this file (for more information, see Section A.2, "List of configuration settings in configuration.xml"). On UNIX: <ORACLE_HOME>/discoverer/config/configuration.xml On Windows: <ORACLE_HOME>\discoverer\config\configuration.xml
convertreg.pl	This script converts a reg_key.dc file to change the format of integer values (e.g. from BigEndian format to LittleEndian format). Use this script to migrate a Discoverer installation from one platform to another platform (e.g from Windows to Solaris). On UNIX: <ORACLE_HOME>/perl/bin/convertreg.pl On Windows: <ORACLE_HOME>\perl\bin\convertreg.pl For more information, see Section 10.8, "About migrating Discoverer preferences".
defaults.txt	This file stores factory-supplied default Discoverer preferences. If pref.txt becomes corrupted, you can use defaults.txt to restore default preference settings. On UNIX: <ORACLE_HOME>/discoverer/util/defaults.txt On Windows: <ORACLE_HOME>\discoverer\util\defaults.txt
dis51pr.exe/dis51pr	This file runs the command line utility used to manage preferences stored in the reg_key.dc file. On UNIX: <ORACLE_HOME>/bin/dis51pr On Windows: <ORACLE_HOME>\bin\dis51pr.exe
discwb.sh	This script file sets environment variables used by Discoverer EUL Command Line for Java. On UNIX: <ORACLE_HOME>/discoverer/discwb.sh On Windows: N/A
error.txt	This file contains information about processing errors collected when you update the Discoverer Preferences component using the applypreferences script. If error.txt is not present, no errors have been logged. On UNIX: <ORACLE_HOME>/discoverer/util/error.txt On Windows: <ORACLE_HOME>\discoverer\util\error.txt
httpd.conf	This file contains configuration information (e.g. the Web server timeout setting Timeout) about the Web server used by Oracle Business Intelligence. On UNIX: <ORACLE_HOME>/Apache/Apache/conf/httpd.conf On Windows: <ORACLE_HOME>\Apache\Apache\conf\httpd.conf
migratediscoconnection.bat/.sh	This script file is used to migrate Oracle Applications private connections created in earlier versions of Discoverer to make them available in Version 10.1.2.1. Note: For information on migrating Discoverer connections from earlier versions of Discoverer to Version 10.1.2.1, see Section 15.2.4, "How to migrate Oracle Applications private connections created in earlier versions of Discoverer to make them available in Version 10.1.2.1". On UNIX:<ORACLE_HOME>/discoverer/util On Windows:<ORACLE_HOME>\discoverer\util
migrateprefs.bat/.sh	This script file is used to migrate Discoverer preferences from Discoverer 9.0.4 to Discoverer 10.1.2. Note: For information on migrating Discoverer preferences from Discoverer 9.0.4 to Discoverer 10.1.2, see the OracleBI Discoverer section in the Oracle Application Server Migration Guide. On UNIX: <ORACLE_HOME>/discoverer/util/migrateprefs.sh On Windows: <ORACLE_HOME>\discoverer\util\migrateprefs.bat
mod_osso.conf	This file stores configuration settings for OracleAS Single Sign-On (e.g, settings to turn OracleAS Single Sign-On on and off). On UNIX: <ORACLE_HOME>/apache/apache/conf/mod_osso.conf On Windows: <ORACLE_HOME>\apache\apache\conf\mod_osso.conf For more information about enabling Single Sign-On, see Section 14.7.2.2, "How to enable and disable Single Sign-On for Discoverer".
opmn.xml	This file stores the OPMN configuration settings for Discoverer (e.g. server timeout, maximum number of Discoverer sessions). Note: Use Application Server Control to control the settings in this file. On UNIX: <ORACLE_HOME>/opmn/conf/opmn.xml On Windows: <ORACLE_HOME>\opmn\conf\opmn.xml For more information, see Section A.3, "List of configuration settings in opmn.xml".
opmnctl.bat/.sh	This script file is used to manage OPMN processes. On UNIX: <ORACLE_HOME>/opmn/bin/opmnctl.sh On Windows: <ORACLE_HOME>\opmn\bin\opmnctl.bat Hint: Type opmnctl help to display online help for this script.
pref.txt	This file stores the Discoverer middle tier preferences, and is used to generate the reg_key.dc file. On install, this file is populated using settings in the defaults.txt file. If pref.txt becomes corrupted, copy preferences in defaults.txt to pref.txt to restore default preference settings. On UNIX: <ORACLE_HOME>/discoverer/util/pref.txt On Windows: <ORACLE_HOME>\discoverer\util\pref.txt Note: After editing the pref.txt file, you must run the applypreferences script to apply the preference changes you have made, then stop and restart the Discoverer Service (for more information, see Section 5.3, "About starting and stopping the Discoverer Service").
reg_key.dc	This file stores individual preferences for each user as a unique combination of database and userid. These values override global default values specified in pref.txt. On UNIX: <ORACLE_HOME>/discoverer/.reg_key.dc On Windows: <ORACLE_HOME>\discoverer\reg_key.dc Note: On UNIX implementations, the reg_key.dc is a hidden UNIX file (i.e. the filename is prefixed with a '.'). Make sure that your file manager program or command console can list hidden files (e.g. use the console command 'ls -al' to list hidden files).
tnsnames.ora	This file contains the names and aliases of all the databases that users can access using OracleBI Discoverer. On UNIX: <ORACLE_HOME>/network/admin/tnsnames.ora On Windows: <ORACLE_HOME>\network\admin\tnsnames.ora
upgradeMR.bat/.sh	This file updates the Discoverer part of the MR to version 10.1.2. If you want to use OracleBI Discoverer Portlet Provider 10.1.2. with OracleAS Portal 9.0.4, you must upgrade only the OracleBI Discoverer part of the 9.0.4 OracleAS Metadata Repository (MR) using the upgradeMR script. For more information, see Oracle Business Intelligence Discoverer Publishing Workbooks in Oracle Application Server Portal. On UNIX: <ORACLE_HOME>/discoverer/util/upgradeMR.sh On Windows: <ORACLE_HOME>\discoverer\util\upgradeMR.bat
web.xml	This file contains deployment information about the Discoverer servlets. On UNIX: <ORACLE_HOME>/j2ee/OC4J_BI_Forms/applications/discoverer/discoverer/WEB-INF/web.xml On Windows: <ORACLE_HOME>\j2ee\OC4J_BI_Forms\applications\discoverer\discoverer\WEB-INF\web.xml

A.2 List of configuration settings in configuration.xml

This file stores configuration settings for Discoverer. The table below shows the settings in configuration.xml.

Note: Do not edit this file manually unless you are following instructions in this guide. You typically use the Discoverer Services Configuration page in Application Server Control to configure settings in this file.

To change the Discoverer Portlet Provider settings, use the Discoverer Portlet Provider Configuration page in Oracle Application Server Control (for more information, see Section 5.6.1, "How to change configuration options for individual Discoverer client tier components").

Setting	Description
enableAppsSSO	Specifies whether authenticated OracleAS Single Sign-On users using an SSO-enabled Oracle Applications database can create and use Discoverer private connections without entering a password (for more information, see Section 15.2.2, "How to enable Oracle Applications users to create or use private connections to SSO-enabled Oracle Applications databases"). Note: You set the value using the Allow authenticated OracleAS Single Sign-On (SSO) users to create and use private connections to SSO-enabled Oracle Applications databases, without entering a password check box on the Discoverer Configuration page in Oracle Application Server Control.
/disco:configuration/plus/@jvm	Specifies the Java Virtual Machine to use for Discoverer Plus (for more information, see Section 5.9.2, "How to specify your own Java Virtual Machine for Discoverer Plus").
/disco:configuration/plus/@laf	Specifies the Look and Feel to use for Discoverer Plus (for more information, see Section 9.1.4, "How to define a custom LAF for Discoverer Plus Relational and Discoverer Plus OLAP").
/disco:configuration/portlet/sessionPool/@maxDataRows	Specifies the number of rows that Discoverer Portlet Provider caches for each Discoverer portlet (default is 1000). You might change this value to increase or decrease the amount of memory used by Discoverer Portlet Provider. For example, you might increase this value to improve the performance of Discoverer portlets with a large number of rows, although Discoverer Portlet Provider might use more system resources (e.g. memory, storage space).
/disco:configuration/portlet/sessionPool/@maxGenericParameters	Specifies the maximum number of generic Portlet parameters associated with Discoverer Portlets.
/disco:configuration/portlet/sessionPool/@maxNewSessionPerMinute	Specifies the maximum number of sessions created per minute.
/disco:configuration/portlet/sessionPool/@maxSessionAgeHour	Specifies the maximum amount of time (in hours) that a Discoverer Session is allowed to be in the session pool. When this limit expires, Discoverer removes this session from the pool. The default value for this parameter is 1 hour. Setting this parameter to a lower value will recycle sessions faster, but might slow down the refreshes due to the need to restart sessions. Note: You set the value using the Maximum Session Age field on the Discoverer Portlet Provider Configuration page in Oracle Application Server Control.
/disco:configuration/portlet/sessionPool/@maxSessionInactivityPeriodMinute	Specifies the maximum amount of time (in minutes) that a Discoverer Session is allowed to be inactive in the session pool. When this limit expires, Discoverer removes this session from the pool. For example, if you have a session in the pool which is continuously used and is never inactive for more than the maxSessionInactivityPeriodMinute limit, Discoverer removes this session from the pool only when the maxSessionAgeHour is reached. However, if the pool has a session that is not being used continuously, Discoverer removes this session from the pool when the maxSessionInactivityPeriodMinute is reached. Note: You set the value using the Maximum Session Inactivity field on the Discoverer Portlet Provider Configuration page in Oracle Application Server Control.
/disco:configuration/portlet/sessionPool/@maxSessions	Specifies the number of sessions that Discoverer Portlet Provider uses for portlet refreshes and portlet publishing. Note: You set this value using the Maximum Sessions field on the Discoverer Portlet Provider Configuration page in Oracle Application Server Control (for more information, see Section 5.6.1, "How to change configuration options for individual Discoverer client tier components"). Note: This value must be equal to or less than the value of the maxprocs setting in opmn.xml (for more information, see Section A.3, "List of configuration settings in opmn.xml").
/disco:configuration/portlet/sessionPool/@minRequestThreadPoolSize	Specifies the minimum size of thread pool used to handle user requests. If the number of users accessing the system increases by the set value, the number of user handling threads increases accordingly.
/disco:configuration/portlet/sessionPool/@peekSleepIntervalSec	Specifies the sleep interval to retrieve portlets to be refreshed. When more than one Discoverer Portlet Provider instance is deployed, this value helps to distribute the refreshes over the portlet provider instances.
/disco:configuration/portlet/sessionPool/@maxWaitNewSessionMinute	Specifies the maximum number of re-tries for creating a session before aborting. Note: You set the value using the Maximum Wait Time field on the Discoverer Portlet Provider Configuration page in Oracle Application Server Control.
/disco:configuration/viewer/switchWorksheetBehavior	Specifies the Discoverer Viewer behavior if an end user opens a different worksheet when they have made changes to the current worksheet. Valid values are: always_save When switching worksheets within a workbook, save changes to the worksheet (i.e save the whole workbook) without prompting the end user to confirm. never_save When switching worksheets within a workbook, discard changes to the worksheet without prompting the end user to confirm. prompt When switching worksheets within a workbook, prompt the user to select either save, cancel, or discard changes to the worksheet. Note: If this setting is not present in the file, Discoverer defaults to 'prompt'.

A.3 List of configuration settings in opmn.xml

This file stores OPMN settings for Discoverer. The table below shows the setting in opmn.xml that you might change if you need to modify the default Discoverer configuration:

Setting	Description
FND_SECURE	Specifies the directory containing a DBC file that Discoverer uses to connect to an Oracle Applications database in secure mode. Discoverer first attempts to find a DBC file with the filename <database name>.dbc. If not found, Discoverer then attempts to use a file with the filename <host name>_<SID>.dbc. If this value is not set, Discoverer attempts to use the value specified by FND_TOP.
FND_TOP	Specifies the directory path for the secure directory containing a DBC file that Discoverer uses to connect to an Oracle Applications database in secure mode (i.e. $<FND_TOP>/secure). This variable is included for backwards compatibility. Discoverer first attempts to use the value specified by FND_SECURE.
ORBDebug	Specifies whether Discoverer instructs the ORB to print debugging messages from the server configurator network. This option does not have a value, but is used as a toggle to enable or disable debugging messages.
ORBDebugLevel=<level>	Specifies the level of debugging in the ORB. The range is 1 for the minimum amount of debugging information to 10 for the maximum amount of debugging information.
ORBLogFile=<name of log file>	Specifies that all ACE_DEBUG and ACE_ERROR messages are redirected to the file specified. If you do not specify a path, the file is created in the directory in which the server is running (e.g. $ORACLE_HOME).
ORBObjRefStyle=[IOE\|URL]	Specifies the user-visible style of object references. The IOR style (default) is the conventional CORBA object reference, whereas the URL style looks more like a URL.
ORBVerboseLogginglevel=[0\|1\|2]	Specifies the amount of status data printed on each line of the debug log. Higher numbers generate more output.
process-type id="PreferenceServer"	Specifies whether the preferences will be started by OPMN. This setting is useful in clustered environments where only one Preferences server should be running. The default value for this setting is: <process-type id="PreferenceServer" enabled="true">.
process-type id="SessionServer" module-id="Disco_SessionServer" maxprocs=<value>	Specifies the maximum number of Discoverer sessions (default 50) that can run at the same time (for Discoverer Plus, Discoverer Viewer, and Discoverer Portlet Provider). You might increase this value if you need to support more concurrent Discoverer users. The value must be a positive integer. Note: This value must be equal to or greater than the value of the /portlet/sessionPool/@maxSessions setting in configuration.xml (for more information, see Section A.2, "List of configuration settings in configuration.xml").
process-type id="SessionServer" module-id="Disco_SessionServer" timeout=<value>	Specifies the length of time (in seconds) that the servlet waits for the Discoverer server process to respond value must be a positive integer. You might need to increase this value if the machine is heavily loaded and is unable to start the server in the default time allowed (i.e. 30 seconds).
module_data\ssl_enabled	Specifies that SSL is enabled.
variable id="TEMP"	Specifies the location of a temporary file called dc* that Discoverer stores on the OracleBI middle tier during a worksheet export. The default location is specified during OracleBI installation. If you want to change the location of the temporary file, change the value of this variable. For example, you might change the value from d:\temp to g:\temp.

Note: The ORB element is not included by default. If you want to customize the TAO ORB, add the ORB elements and attributes as described in the table above. For more information, refer to TAO documentation.