A Oracle BI 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 Oracle BI Discoverer. Many of the settings in the configuration files are configured using Fusion Middleware Control. Where possible, use Fusion Middleware 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_INSTANCE>/Discoverer/Discoverer_<instance-name>/util/applypreferences.sh On Windows: <ORACLE_INSTANCE>\Discoverer\Discoverer_<instance-name>\util\applypreferences.bat Tip: Information about processing errors are stored in error.txt (for more information, see File name entry for error.txt).
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_INSTANCE>/Discoverer/Discoverer_<instance-name>/util/checkdiscoverer.sh On Windows: <ORACLE_INSTANCE>\Discoverer\Discoverer_<instance-name>\checkdiscoverer.sh 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_INSTANCE>/Discoverer/Discoverer_<instance-name>/util/collectlogs.sh On Windows: <ORACLE_INSTANCE>\Discoverer\Discoverer_<instance-name>\util\collectlogs.bat Note: For more information about using the collectlogs script, see Section 11.5, "How to copy Discoverer log files".
configuration.xml	This file stores configuration settings for Discoverer. Note: Do not edit this file manually. Contact Oracle Support for assistance. For more information, see Section A.2, "List of configuration settings in configuration.xml". On UNIX: <DOMAIN_HOME>/servers/WLS_DISCO/stage/discoverer/<discoverer_version>/discoverer/configuration/configuration.xml On Windows: <DOMAIN_HOME>\servers\WLS_DISCO\stage\discoverer\<discoverer_version>\discoverer\configuration\configuration.xml
convertreg.pl	This script converts a reg_key.dc file to change the format of integer values (for example, from BigEndian format to LittleEndian format). Use this script to migrate a Discoverer installation from one platform to another platform (for example, 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 9.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_INSTANCE>/config/PreferenceServer/Discoverer_<instance-name>/defaults.txt On Windows: <ORACLE_INSTANCE>\config\PreferenceServer\Discoverer_<instance-name>\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_INSTANCE>/config/PreferenceServer/Discoverer_<instance-name>/discwb.sh<ORACLE_INSTANCE>/Discoverer/Discoverer_<instance-name>/util/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_INSTANCE>/config/PreferenceServer/Discoverer_<instance-name>/error.txt On Windows: <ORACLE_INSTANCE>\config\PreferenceServer\Discoverer_<instance-name>\error.txt
httpd.conf	This file contains configuration information (for example, the Web server timeout setting Timeout) about the Web server used by Oracle Business Intelligence. On UNIX: <ORACLE_INSTANCE>/config/OHSComponent/<ohs-comp-name>/httpd.conf On Windows: <ORACLE_INSTANCE>\config\OHSComponent\<ohs-comp-name>\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: This script file is only available in version 10.1.2.1, and is not found in version 11.1.1 or later. Note: For information on migrating Discoverer connections from earlier versions of Discoverer to Version 10.1.2.1, see Section B.2.6, "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 Oracle BI Discoverer section in the Oracle Fusion Middleware Migration Guide. On UNIX: <ORACLE_INSTANCE>/config/PreferenceServer/Discoverer_<instance-name>/migrateprefs.sh On Windows: <ORACLE_INSTANCE>\config\PreferenceServer\Discoverer_<instance-name>\migrateprefs.bat
mod_osso.conf	This file stores configuration settings for Oracle Single Sign-On (for example, settings to turn Oracle Single Sign-On on and off). On UNIX: <ORACLE_INSTANCE>/config/OHSComponent/<ohs-comp-name>/mod_osso.conf On Windows: <ORACLE_INSTANCE>\config\OHSComponent\<ohs-comp-name>\mod_osso.conf For more information about enabling Single Sign-On, see Section 13.7.2.2, "How to enable and disable Single Sign-On for Discoverer".
opmn.xml	This file stores the OPMN configuration settings for Discoverer (for example, server timeout, maximum number of Discoverer sessions). On UNIX: <ORACLE_INSTANCE>\config\OPMN\<opmn-component-name>\opmn.xml On Windows: <ORACLE_INSTANCE>/config/OPMN/<opmn-component-name>/opmn.xml
opmnctl.bat/.sh	This script file is used to manage OPMN processes. On UNIX: <ORACLE_INSTANCE>/config/OPMN/<opmn-component-name>/opmnctl.sh On Windows: <ORACLE_INSTANCE>\config\OPMN\<opmn-component-name>\opmnctl.bat Tip: Type `opmnctl help` to view 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. Note: Do not edit this file manually. Contact Oracle Support for assistance. On UNIX: <ORACLE_INSTANCE>/config/PreferenceServer/Discoverer_<instance-name>/pref.txt On Windows: <ORACLE_INSTANCE>\config\PreferenceServer\Discoverer_<instance-name>\pref.txt Note: If you manually edit the pref.txt file, you must run the applypreferences script to apply the preference changes you have made, then stop and restart the Discoverer preferences server component (for more information, see Section 4.3, "How to start, stop, and restart the Discoverer preferences server component using opmnctl").
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. Note: Do not edit this file manually. Contact Oracle Support for assistance. For more information, see Section A.2, "List of configuration settings in configuration.xml". On UNIX: <ORACLE_INSTANCE>/config/PreferenceServer/Discoverer_<instance-name>/.reg_key.dc On Windows: <ORACLE_INSTANCE>\config\PreferenceServer\Discoverer_<instance-name>\reg_key.dc Note: On UNIX implementations, the reg_key.dc is a hidden UNIX file (that is, the filename is prefixed with a '.'). Ensure that your file manager program or command console can list hidden files (for example, 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 Oracle BI Discoverer. On UNIX: <ORACLE_INSTANCE>/config/tnsnames.ora On Windows: <ORACLE_INSTANCE>\config\tnsnames.ora
web.xml	This file contains deployment information about the Discoverer servlets. On UNIX: MW_HOME/user_projects/domains/ClassicDomain/ servers/WLS_DISCO/stage/discoverer/<discoverer_version>/discoverer/discoverer.war/WEB-INF/web.xml On Windows: MW_HOME\user_projects\domains\ClassicDomain\ servers\WLS_DISCO\stage\discoverer\<discoverer_version>\discoverer\discoverer.war\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 pages in Fusion Middleware Control to configure settings in this file.

To change the Discoverer Portlet Provider settings, use the Discoverer Portlet Provider Configuration page in Oracle Fusion Middleware Control (for more information, see Section 4.6.1, "How to configure Discoverer client-tier components").

Setting	Description
enableAppsSSOConnection	Specifies whether authenticated Oracle 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 14.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 Oracle 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 Administration page in Oracle Fusion Middleware Control.
/disco:configuration/viewer/pageNavigation	Specifies whether the page navigation tool is displayed in Discoverer Viewer. Valid values are: TRUE When the value of this setting is set to TRUE, the page navigation tool is displayed in worksheets. When the page navigation tool is displayed, query results are returned to the worksheet non-incrementally (all together). This might reduce performance when displaying large data sets the first time it is rendered. FALSE When the value of this setting is set to FALSE, the page navigation tool is not displayed in worksheets. When the page navigation tool is not displayed, query results are returned to the worksheet incrementally (in chunks). This improves performance when displaying large data sets. Note: You set the value using the MBean Browser in Oracle Fusion Middleware Control.
GraphAxisAutoScaledFromZero	Specifies whether Discoverer Viewer (only when used with a multidimensional data source) displays graph scaled from zero or values based on the worksheet data. Valid values are: TRUE When the value of this setting is TRUE, all the graph axes in Discoverer Viewer scales from zero only. The default value of this setting is TRUE. FALSE When the value of this setting is FALSE, the graph axes in Discoverer Viewer start the scale based on the worksheet data. Note: You set the value using the System MBean Browser in Oracle Fusion Middleware Control.
EnableLevelOffsetBasedTimeCalc	Specifies the kind of calculation templates that Discoverer Plus OLAP users see. By default, this setting is TRUE, so that users see the level-offset based templates that are new to Release 11.1.1 when they create a calculation or edit a calculation that was created with those templates. They see the calendar-based templates from Release 10.1.2 when they edit a calculation that was created with those templates. You can change the default to use the Release 10.1.2 templates if the time hierarchy is modeled on the Gregorian calendar Add this setting within the <plus> tag, directly after the <enablePlus> tag.
ExcludeDuplicateRowsDuringExcelExport	Specifies whether duplicate rows are filtered when you export a worksheet from Discoverer Plus OLAP to Microsoft Excel. Valid values are: TRUE Duplicate rows are not shown in the Microsoft Excel report. FALSE Duplicate rows are shown in the Microsoft Excel report.
ExcludeDuplicateColumnsDuringExcelExport	Specifies whether duplicate columns are filtered when you export a worksheet from Discoverer Plus OLAP to Microsoft Excel. Valid values are: TRUE Duplicate columns are not shown in the Microsoft Excel report. FALSE Duplicate columns are not shown in the Microsoft Excel report.
SortMemberStepHierarchically	Specifies whether Member Steps are sorted hierarchically in Discoverer Plus OLAP. When this option is disabled, members are sorted in the order in which they are added, rather than in hierarchical order. Valid values are: DEFAULT Always sort members hierarchically and do not display the Sort Members Hierarchically check box in the Edit Member Step dialog. YES Sort members hierarchically, display the Sort Members Hierarchically check box in the Edit Member Step dialog, and have the box checked by default. Users can deselect the box to not use hierarchical order. YES is the default value for this parameter when Discoverer Plus OLAP is first installed. NO Sort members in the order of selection, display the Sort Members Hierarchically check box in the Edit Member Step dialog, and have the box unchecked by default. Users can check the box to use hierarchical order. Add this setting within the <plus> tag, directly after the <enablePlus> tag.
SwitchWorksheetBehaviour	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 (that is, 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'.
worksheetSaveBehavior	Specifies the Discoverer Viewer saving behavior when the user navigates away from a worksheet after making some changes in it. Note that this parameter is not effective when you switch between worksheets. This setting is done in the <viewer> section of the configuration.xml file. Valid values are: always_save When navigating from a worksheet, save changes to the worksheet without prompting the end user to confirm. never_save When navigating from a worksheet, discard changes to the worksheet without prompting the end user to confirm. prompt When navigating from a worksheet, 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'.
propagateGUIDToVPD	Specifies whether the GUID or the Oracle Single Sign-On user name is passed into Virtual Private Database (VPD) policies. Valid values are: TRUE When the value of this setting is set to TRUE, the GUID is propagated to VPD policies. FALSE When the value of this setting is set to FALSE, the SSO User Name is propagated to VPD policies. Note: You set the value using the User ID field in the Discoverer Administration page in Oracle Fusion Middleware Control.
pickerCompatibleVersions	Specifies whether the Date or Color pickers are available on the Portal. To make these pickers available for different versions of Portal, change this parameter to the respective Portal version. For example, to view the Date or Color pickers on 10.1.4 Portal, change the value of pickerCompatibleVersions to "10.1.4".
isCurrentPageItemsExportForOLAP	Specifies how Discoverer Viewer exports worksheets of OLAP data that have page items when you export to Microsoft Excel or to HTML. Valid values are: TRUE Exports a worksheet of OLAP data to Microsoft Excel or to HTML with the current set of page items. FALSE Exports all possible combinations of page items to Microsoft Excel or to HTML. This optional setting is present in the <viewer> section of the configuration.xml file with default value as FALSE.
cacheThreshold	Specifies the number of cache entries maintained in the infrastructure database and improves the display of portlet data as the user changes parameter values. You can set this value in the <portlet> section of the configuration.xml file. Default value for this setting is "1". In this case, Discoverer Portlet Provider maintains only the previous cache entry in addition to the results for the current combination of values. Note: When you set cacheThreshold to a value higher than 1, it can increase the amount of space consumed in the infrastructure database and the amount of time required for each portlet to refresh. For example, with cacheThreshold="15", at refresh time, the query for the portlet might run 15 times and that the DB space needed to store the results is 15 times greater. You must set cacheThreshold judiciously and ensure that portlet refreshes are completed within a reasonable time.
viewerURLForPublicUser	Specifies the behavior when you click the Analyze link on a public Portal page. When you specify the value of this setting as "normalViewer", clicking the Analyze link takes you to Discoverer Viewer. This setting is defined in the <portlet> section of configuration.xml. Note that if the user logs into Portal or SSO then the Analyze link always open the Single Worksheet Viewer irrespective of the setting in configuration.xml file.
enableDataSelection	Specifies whether Discoverer Viewer enables you to select data in a table and copy it to clipboard as in an HTML page. Valid values are: TRUE Enables column selection in the table and disables data selection for copying to clipboard. FALSE Disables the column selection in the table and enables you to select and copy data to a clipboard. This optional setting is present in the <viewer> section of the configuration.xml file with default value as TRUE.
numberOfLOVsToBeDisplayed	Specifies the number of values to be displayed in the list box of the parameter search dialog. This optional setting is present in the <viewer> section of the configuration.xml file. The default value of this setting is 25.
numColsForLOW	Specifies the number of columns to be displayed for the List of Worksheet portlet when it is opened in Single Worksheet Viewer. This optional setting is present in the <portlet> section of the configuration.xml file. The default value is 6. If you specify the value of this setting as '0', all columns from the worksheet are displayed.
numRowsForLOW	Specifies the number of rows to be displayed for the List of Worksheet portlet when it is opened in Single Worksheet Viewer. This optional setting is present in the <portlet> section of the configuration.xml file. The default value is 25. If you specify the value of this setting as '0', all rows from the worksheet are displayed.
peekSleepIntervalSec	Specifies the sleep interval for retrieving scheduled portlets to be refreshed. The default value of this parameter is 2 seconds. Note: If there is more than one middle tier, for load balancing scheduled portlets, you can specify different values for this parameter in each of the middle tiers. The scheduled refreshes are then distributed more evenly among the middle tiers.

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 (that is, $<FND_TOP>/secure). This variable is included for backward 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 (for example, $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.

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.