14 Configuration Parameters and the Registry

This chapter describes use of the registry for various Oracle Database for Windows components. It also lists recommended values and ranges for configuration parameters.

This chapter contains these topics:

About Configuration Parameters
Registry Overview
Registry Parameters
Oracle Real Application Clusters Registry Parameters
Managing Registry Parameters with regedt
Managing Registry Parameters with Oracle Administration Assistant for Windows
Modifying Oracle Counters for Windows Performance Monitor Parameters

About Configuration Parameters

Oracle Database for Windows uses configuration parameters to locate files and specify runtime parameters common to all Oracle products. When an Oracle program or application requires a translation for a particular configuration variable, Oracle Database for Windows uses the associated parameter. All Oracle parameters are stored in the registry.

Registry Overview

Oracle Database for Windows stores its configuration information in a repository (the registry) that is organized in a tree format. The tree format consists of keys in the registry and parameter values for the keys. Keys and parameter values can be viewed and modified in Registry Editor.

Keys are folders that appear in the left pane of a Registry Editor window. A key contains subkeys or parameters.

Caution:

Although Registry Editor lets you view and modify registry keys and parameter values, you normally are not required to do so. In fact, you can render your system useless if you make incorrect changes. Therefore, only advanced users should edit the registry! Back up your system before making any changes in the registry.

Parameters in Registry Editor appear as a string, consisting of three components:

Parameter name
Value class or type of entry
Value itself

For example, parameter ORACLE_SID can have the following entry in the registry:

ORACLE_SID:reg_sz:orcl1

Value classes for Oracle Database for Windows parameters are:

String value with a REG_SZ, REG_EXPAND_SZ (for an expandable string), or a REG_MULTI_SZ (for multiple strings) prefix to identify a parameter value entry as a data string
Binary value with a REG_DWORD prefix to identify a value entry as a dword (hexadecimal data) entry

Most Oracle Database for Windows parameter values are string types. Use Oracle Universal Installer defaults when a type is not given.

Registry Parameters

This section describes Oracle Database for Windows registry parameters for the following keys. Other products, such as Oracle Enterprise Manager, have additional keys and parameters that are not described in this chapter.

HKEY_LOCAL_MACHINE\SOFTWARE\ORACLE\KEY_HOME_NAME
HKEY_LOCAL_MACHINE\SOFTWARE\ORACLE
HKEY_LOCAL_MACHINE\SYSTEM\CurrentControlSet\Services

Note:

Oracle Database for 64-bit Windows has additional configuration parameters that enable and control large page support. See "Large Page Support".

To modify these registry values, see "Managing Registry Parameters with regedt".

HKEY_LOCAL_MACHINE\SOFTWARE\ORACLE\KEY_HOME_NAME

Each time you install Oracle products into a new Oracle home on your computer, HKEY_LOCAL_MACHINE\SOFTWARE\ORACLE\KEY_HOME_NAME is created. This subkey contains parameter values for most Oracle products.

Note:

See Appendix B, "Optimal Flexible Architecture", in Oracle Database Installation Guide for Microsoft Windows Itanium (64-Bit) for details on the PATH variable and registry values when you are working with multiple Oracle homes.

HKEY_LOCAL_MACHINE\SOFTWARE\ORACLE\HKEY_LOCAL_MACHINE\SOFTWARE\ORACLE\KEY_HOME_NAME includes the following parameters for an Oracle home directory. Depending on products you install, additional parameters can also be created. See your Windows development manuals.

MSHELP_TOOLS

Specifies the location of Windows help files. The default value is

ORACLE_BASE\ORACLE_HOME\mshelp

NLS_LANG

Specifies supported language, territory, and character set. This parameter specifies the language in which messages appear, the territory and its conventions for calculating week and day numbers, and the character set displayed. Oracle Universal Installer sets this value during installation based on the language setting of the operating system. See Oracle Database Globalization Support Guide for a list of values.

ORA_CWD

Specifies current working directory. For example, if you set this parameter and then use ORADIM, a log file called oradim.log is created in this directory. This parameter must be manually set.

ORA_SID_AUTOSTART

Starts Oracle Database when OracleServiceSID service is started. The default value is true.

ORA_SID_PFILE

Specifies full path to initialization parameter file. The default value is ORACLE_BASE\admin\DB_NAME\pfile\init.ora

ORA_SID_SHUTDOWN

When set to true, the default value, this parameter shuts down the instance of Oracle Database identified by SID when OracleServiceSID is stopped manually—using either the Control Panel or Net stop command.

ORA_SID_SHUTDOWN_TIMEOUT

Sets maximum time (in seconds) to wait for shutdown to complete before the service for a particular SID stops. The default value is 30.

ORA_SID_SHUTDOWNTYPE

Specifies mode in which Oracle Database is shut down when you stop OracleServiceSID. Valid values are a (abort), i (immediate), and n (normal). The default value is i.

ORA_TZFILE

Specifies location of time zone file. Each file contains:

Valid time zone names
Offset from UTC
Abbreviation for standard time
Abbreviation for daylight savings time

In previous releases, the default value for ORA _TZFILE was

ORACLE_BASE\ORACLE_HOME\oracore\zoneinfo\timezone.dat

Beginning with Oracle Database 10g Release 1 (10.1), the default value is

ORACLE_BASE\ORACLE_HOME\oracore\zoneinfo\timezlrg.dat

The former default, timezone.dat, contains most commonly used time zones and is smaller for better database performance. The new default, timezlrg.dat, includes time zones not defined in the smaller file. To enable use of the smaller file, the database administrator must:

Shut down Oracle Database.
Set ORA_TZFILE to the full path name of the location of timezone.dat file.
Restart Oracle Database.

To view time zone names, use SQL*Plus to make the following query:

SELECT * from v$timezone_names

If the larger timezlrg.dat file is used, then it must stay in use unless the user is sure that no data uses one of the added time zones. Also, all databases that share information must use the same time zone file.

ORACLE_AFFINITY

Specifies Windows processor affinity of each thread within the Oracle Database process. This parameter must be manually added. Oracle recommends consulting Oracle Support Services before changing this parameter. The format is:

name1:cpumask1;name2:cpumask2

Each name setting must be the name of a background thread, user for non-background (shadow) threads, or def for any thread type not handled specifically.

The name mask sets the affinity mask of the Oracle Database process. Valid background thread names include DBW0, LGWR, PMON, SMON, ARCH, RECO, CKPT, TRWR, SNP0 through SNP9, P000 through P481, and any other name found in the NAME column of the v$bgprocess data dictionary view.

Each affinity setting must be a valid affinity mask (or its numeric equivalent) for the corresponding name. Process affinity masks are used only when Oracle services are first started. Each thread's affinity is set only when the individual thread is started (for example, at database startup time for the background threads).

ORACLE_BASE

Specifies the top-level Oracle directory (for example, C:\oracle\product\10.2.0) that contains ORACLE_HOME, admin, and oradata. The default is ORACLE_BASE.

ORACLE_GROUP_NAME

Specifies the name of the group containing icons of the Oracle products installed. The parameter is added to your registry when you first install Oracle products, even if Oracle Universal Installer does not create a program group for Oracle products you have installed (for example, if you have installed only Oracle Net software). The default value is Oracle - HOME_NAME.

ORACLE_HOME

Specifies Oracle home directory in which Oracle products are installed. This directory is immediately beneath the Oracle base directory in the Oracle directory hierarchy. The default value is the drive letter and name that you specify during installation.

ORACLE_HOME_KEY

The HKEY_LOCAL_MACHINE location of Oracle parameters. The default value is software\oracle\HOMEID.

ORACLE_HOME_NAME

Specifies home name of Oracle home directory in which Oracle products are installed. The default value is the name that you specify during installation.

ORACLE_PRIORITY

Determines Windows scheduling priorities of threads within the Oracle Database management system process. The format is:

name1:priority1;name2:priority2 . . .

The name class sets the priority class of the Oracle Database process. Threads can be assigned priority either collectively or individually. The collective name user designates non-background (shadow) threads; the collective name def designates any thread type not handled specifically. Valid individual background thread names include DBW0, LGWR, PMON, SMON, ARCH0, RECO, CKPT, TRWR, SNP0 through SNP9, and any other name found in the NAME column of the v$bgprocess data dictionary view.

The default value is class:normal; def:normal.

Note:

ORACLE_PRIORITY is not automatically created for you in the registry. When it is not defined in the registry, Windows default values are used for thread priorities.

ORACLE_SID

Specifies the name of the Oracle Database instance on the host computer. The value of this parameter is the SID for the instance. The default value is specified by the entry in the Database Identification window of Oracle Universal Installer.

OSAUTH_PREFIX_DOMAIN

Enables user authentication. When it is set to true, it enables the server to differentiate between one username and another, whether they are local users, domain users, or domain users on another domain in your network. When it is set to false, the domain is ignored, and the local user becomes the default value of the operating system user returned to the server. The default value is true.

OSAUTH_X509_NAME

Enables client users to access Oracle Database as X.509-compliant enterprise users. This parameter is required only if you want to use enterprise users and roles in an Oracle Database computer running in a Windows 2000 domain. The default value is false.

RDBMS_ARCHIVE

Specifies the location of backup database files. The default value is ORACLE_BASE\ORACLE_HOME\database\archive.

RDBMS_CONTROL

Specifies the location of backup database control files. The default value is ORACLE_BASE\ORACLE_HOME\database.

SQLPATH

Specifies the location of SQL scripts. The default value is ORACLE_BASE\ORACLE_HOME\dbs.

HKEY_LOCAL_MACHINE\SOFTWARE\ORACLE

This subkey contains the following parameters:

INST_LOC

Specifies the location of Oracle Universal Installer files. The default value is System Drive:\program files\oracle\inventory.

OO4O

Specifies the location of Oracle Objects for OLE message files. The default value is ORACLE_BASE\ORACLE_HOME\oo4o\mesg.

HKEY_LOCAL_MACHINE\SYSTEM\CurrentControlSet\Services

HKEY_LOCAL_MACHINE\SYSTEM\CurrentControlSet contains four keys:

Control
Enum
HardwareProfiles
Services

The first three are used by the operating system. You can edit only the Services subkey, which contains:

Parameters for Oracle Counters for Windows Performance Monitor
Parameters for Oracle Database Services

Parameters for Oracle Counters for Windows Performance Monitor

Oracle Counters for Windows Performance Monitor parameters appear in:

HKEY_LOCAL_MACHINE\SYSTEM\CURRENTCONTROLSET\SERVICES\ORACLEver\PERFORMANCE

where ORACLEver refers to whatever version of Oracle Database is installed.

For multiple Oracle homes compliance starting with Oracle Database 10g Release 1 (10.1), parameters Hostname, Username, Password, LOGFILE, and PERF_FILE_NAME have been moved to

HKEY_LOCAL_MACHINE\SYSTEM\CURRENTCONTROLSET\SERVICES\ORACLEver\PERFORMANCE\KEY_HOME_NAME.

Note:

Modify only the Hostname, Password, and Username values to point to any database. Oracle recommends that you use operfcfg. See "Using operfcfg".

For Oracle Counters for Windows Performance Monitor to display information for Oracle Database performance objects, it must log in to the database. Modify the following parameters if the default information is not applicable or if you want to access another database:

Hostname displays the SID of the database that Oracle Counters for Windows Performance Monitor will connect to. The default value is blank, causing Oracle Counters for Windows Performance Monitor to connect to the default database on the computer.

If you specify a different SID, you must also add a connect descriptor for that SID to your tnsnames.ora file. Oracle recommends that you use Oracle Net Configuration Assistant, but you can also copy, paste, and modify the following example:
```
SERVICE_NAME =
  (DESCRIPTION =
    (ADDRESS_LIST =
      (ADDRESS = (PROTOCOL = TCP)(HOST = HOST_NAME)(PORT = 1521))
    )
    (CONNECT_DATA =
      (SERVER = DEDICATED)
      (SERVICE_NAME = SERVICE_NAME)
    )
  )
```
Password displays the encrypted password for the username to access the database. The default value is MANAGER (encrypted).
Username displays the username to access the database. The default value is SYSTEM.

Oracle Counters for Windows Performance Monitor requires the following parameters as entry points:

Close specifies the close entry point for the DLL. The default value is CloseOracleverPerformanceData.
Collect specifies the collect entry point for the DLL. The default value is CollectOracleverPerformanceData.
Library specifies the name of the Oracle Counters for Windows Performance Monitor DLL. The default value is ORAPERFver.dll
Open specifies the open entry point for the DLL. The default value is OpenOracleverPerformanceData.

The following parameters specify Oracle Counters for Windows Performance Monitor log file and object configuration files:

LOGFILE specifies the name of the Oracle Counters for Windows Performance Monitor log file. This log file reports any errors, such as Oracle Database objects not appearing or database access problems. The default value is ORACLE_BASE\ORACLE_HOME\dbs\operfver.log.
PERF_FILE_NAME specifies the location of the PERFver.ora file, which contains all performance objects displayed by Oracle Counters for Windows Performance Monitor. The default value is ORACLE_BASE\ORACLE_HOME\dbs\perfver.ora

Parameters for Oracle Database Services

HKEY_LOCAL_MACHINE\SYSTEM\CURRENTCONTROLSET\SERVICES subkey contains additional subkeys that correspond to each Oracle Database service.

Each service subkey contains the following parameters:

DisplayName specifies the service name of the instance whose SID is SID. The default value is the name of the service. For example, OracleServiceORCL1, where ORCL1 is the SID.
ImagePath specifies the fully qualified path name of the executable started by the service and any command-line arguments passed into the executable at runtime. The default value is the path to the executable file of the product.
ObjectName specifies the logon user account and computer to which the service should log on. The default value is LocalSystem.

Oracle Real Application Clusters Registry Parameters

Oracle Real Application Clusters registry values are based on the clusterware. If you are not using the clusterware, then some of this information may not be applicable to your particular cluster environment.

HKEY_LOCAL_MACHINE\SOFTWARE\ORACLE\OCR

This subkey contains the following values:

OCRROOT points to the location of the Oracle Cluster Registry file
LOCAL_ONLY which is set to False for a cluster installation and True for a single-instance database installation

Managing Registry Parameters with regedt

Caution:

Do not edit your registry unless absolutely necessary. If an error occurs in your registry, then Oracle Database for Windows can stop functioning, and the registry itself can become unusable.

Modifying a Parameter Value with regedt

To edit Oracle-related settings:

Start Registry Editor in one of two ways:
- From the command prompt, enter:
```
C:\> regedt
```
- Choose Start > Run, enter regedt in the Open field, and click OK.
The Registry Editor window appears.
Navigate to the values you want to view or modify by double-clicking appropriate keys.

The left-hand side of the window shows the hierarchy of registry keys, and the right-hand side of the window shows various values associated with a key.
Double-click the parameter to edit.

The String Editor dialog appears:

Description of the illustration stringre.gif
Make any necessary edits.
Click OK.
Choose Exit from the Registry menu.

Adding a Registry Parameter with regedt

To add a parameter to the registry:

Start Registry Editor in one of two ways:
- From the command prompt, enter:
```
C:\> regedt
```
- Choose Start > Run, enter regedt in the Open field, and click OK.
The Registry Editor window appears.
Navigate to the key to which you want to add the new value.
Choose Add Value from the Edit menu.

The Add Value dialog appears:

Description of the illustration addvalue.gif
In the Value Name field, type the name of the value that you want to add to the currently selected key.
In the Data Type list, select the data type that you want to assign to the added value:
- REG_SZ, REG_EXPAND_SZ (for an expandable string), or REG_MULTI_SZ (for multiple strings) for a data string
- Binary value with a REG_DWORD prefix to identify a value entry as a DWORD (hexadecimal data) entry
Click OK.

The String Editor dialog appears:

Description of the illustration stringre.gif
Type the value for the parameter.
Click OK.

Registry Editor adds the parameter.
Choose Exit from the Registry menu.

Managing Registry Parameters with Oracle Administration Assistant for Windows

Instead of using regedt to add, edit, and delete parameters for an Oracle home, you can use the Oracle Home Configuration snap-in, one of several snap-ins included as part of Oracle Administration Assistant for Windows. You must have Microsoft Management Console on your computer to use this product.

Starting Oracle Administration Assistant for Windows

To start Oracle Administration Assistant for Windows:

Choose Start > Programs > Oracle - HOME_NAME > Configuration and Migration Tools > Administration Assistant for Windows.

Oracle Administration Assistant for Windows starts.
Expand Oracle Homes.
Right-click the Oracle home that you want to modify.

Description of the illustration admin1.gif
Click Properties. The Properties dialog appears.

Description of the illustration admin2.gif

Adding Oracle Home Parameters

To add an Oracle home parameter:

Click Add in the Properties dialog.

The Add Value dialog appears.

Description of the illustration admin3.gif
Enter the name in the Parameter Name field.
Enter the value in the Parameter Value field.
Click OK.
Click Apply.

Note:
With Oracle Administration Assistant for Windows, you can add parameters only with a datatype of REG_SZ. Use regedt to add parameters with a datatype of REG_EXPAND_SZ, REG_MULTI_SZ, or REG_DWORD.

Editing Oracle Home Parameters

To change the default SID, select the SID from the Default SID list in the Properties dialog. To edit one of the other parameters:

Select the parameter in the Other Settings list in the Properties dialog.
Click Edit.

Description of the illustration admin4.gif

The Edit Value dialog appears.

Description of the illustration admin5.gif
Modify the value.
Click OK.
Click Apply.

Deleting Oracle Home Parameters

To delete an Oracle home parameter:

Select the parameter in the Other Settings list in the Properties dialog.
Click Delete.

Modifying Oracle Counters for Windows Performance Monitor Parameters

Instead of using regedt to modify Oracle Counters for Windows Performance Monitor's Hostname, Password, and Username parameters, you can use operfcfg or Oracle Administration Assistant for Windows.

Using operfcfg

operfcfg is an Oracle Database tool that you run from the command prompt. You must specify the system password by running operfcfg.exe, located in the ORACLE_HOME\bin directory. operfcfg.exe prompts for a user name, password, and TNS alias.

For example:

DRIVE_LETTER:\> ORACLE_HOME\bin\operfcfg.exe
Enter user-name: system
Enter password: password
Enter tns-alias: orcl
operfcfg: New registry values have been successfully set.

If you run the following command, then operfcfg.exe does not prompt for a password:

operfcfg.exe -U user_name -D tns_alias

The -U and -D commands are optional.

The following examples illustrate the use of operfcfg. First, to change user name to dba_admin and leave database name at its current value, enter:

C:\> operfcfg -U dba_admin

To change username to dba_admin and database name to prod, enter:

C:\> operfcfg -U dba_admin -D prod

In the final example, you change host name to a blank value, causing Oracle Counters for Windows Performance Monitor to connect to the default database on the computer. The current user name and password must be valid user accounts on this database. Enter:

C:\> operfcfg -D

Using Oracle Administration Assistant for Windows

Oracle Counters for Windows Performance Monitor snap-in is part of Oracle Administration Assistant for Windows. You must have Microsoft Management Console on your computer in order to use this product.

To use Oracle Counters for Windows Performance Monitor snap-in:

Choose Start > Programs > Oracle - HOME_NAME > Configuration and Migration Tools > Administration Assistant for Windows.

Oracle Administration Assistant for Windows starts.
Right-click Performance Monitor.
Click Properties.

The Performance Monitor Properties dialog appears.
Modify the text in the Username, Password, or Database fields.
Click Apply.