9
Configuration Parameters and the Registry

This chapter describes use of the registry for various Oracle9i 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
  
  
• Modifying a Registry Value with regedt32
  
  
• Adding a Registry Parameter with regedt32
  
  
• Adding or Modifying Registry Parameters with Oracle Administration Assistant for Windows NT
  
  
• Modifying Oracle Performance Monitor for Windows NT Parameters

About Configuration Parameters

Oracle9i 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, Oracle9i for Windows uses the associated parameter. All Oracle parameters are stored in the registry.

Registry Overview

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

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 Oracle9i 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 Oracle9i for Windows parameter values are string types. Use Oracle Universal Installer defaults when a type is not given.

Registry Parameters

This section describes Oracle9i 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\HOMEID
  
  
• HKEY_LOCAL_MACHINE\SOFTWARE\ORACLE
  
  
• HKEY_LOCAL_MACHINE\SOFTWARE\ORACLE\ALL_HOMES
  
  
• HKEY_LOCAL_MACHINE\SYSTEM\CurrentControlSet\Services

To modify these registry values, see "Modifying a Registry Value with regedt32".

HKEY_LOCAL_MACHINE\SOFTWARE\ORACLE\HOMEID

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

HKEY_LOCAL_MACHINE\SOFTWARE\ORACLE\HOMEID 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. 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 Oracle9i 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 Oracle9i database when OracleServiceSID service is started. Default value is true.

ORA_SID_PFILE

Specifies full path to initialization parameter file (init.ora). 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 Oracle database identified by SID when OracleServiceSID is stopped.

ORA_SID_SHUTDOWN_TIMEOUT

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

ORA_SID_SHUTDOWNTYPE

Specifies mode in which Oracle9i database is shut down when you stop OracleServiceSID. Valid values are a (abort), i (immediate), and n (normal). 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

Default is ORACLE_BASE\ORACLE_HOME\oracore\zoneinfo\timezone.dat. It contains most commonly used time zones and is smaller for better database performance. The optional file, timezlrg.dat, includes time zones not defined in the default; but its use may affect database performance. To enable use of the optional file, the database administrator must:

1. Shut down Oracle9i database.
   
   
2. Set ORA_TZFILE to the full path name of the location of timezlrg.dat file.
   
   
3. Restart Oracle9i database.

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

SELECT * from v$timezone_names 

Once the larger file is used, 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 NT processor affinity of each thread within the Oracle process. This parameter must be manually added. Oracle Corporation 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 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) that contains ORACLE_HOME, \admin, and \oradata. 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). 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. Default value is drive letter and name that you specify during installation.

ORACLE_HOME_KEY

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

ORACLE_HOME_NAME

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

ORACLE_PRIORITY

Determines Windows NT 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 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.

Default value is class:normal; def:normal.

ORACLE_SID

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

RDBMS_ARCHIVE

Specifies location of backup database files. Default value is ORACLE_BASE\ORACLE_HOME\database\archive.

OSAUTH_PREFIX_DOMAIN

Enables user authentication. When set to true, enables 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 set to false, domain is ignored, and the local user becomes the default value of the operating system user returned to server. Default value is false.

OSAUTH_X509_NAME

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

RDBMS_CONTROL

Specifies location of backup database control files. Default value is ORACLE_BASE\ORACLE_HOME\database.

SQLPATH

Specifies location of SQL scripts. Default value is ORACLE_BASE\ORACLE_HOME\dbs.

HKEY_LOCAL_MACHINE\SOFTWARE\ORACLE

This subkey contains the following parameters:

INST_LOC

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

OO4O

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

HKEY_LOCAL_MACHINE\SOFTWARE\ORACLE\ALL_HOMES

This subkey provides general information on each Oracle home directory on a computer.

DEFAULT_HOME

Specifies default Oracle home name (that is, the first Oracle home installed on your computer). Default value is name that you specify during installation. You can also use an Oracle tool to change the default home name. See "Using Oracle Home Selector".

HOME_COUNTER

Specifies the number of installed Oracle homes. Default value is 1.

LAST_HOME

Displays ID number of most recently installed Oracle home. For example, if HOME0 was most recently installed Oracle home, then number 0 appears. Default value is 0.

IDx

This subkey corresponds to HOMEID of the same number (for example, HOME0 for the first installation, HOME1 for the second installation, and so on). IDx contains NAME and PATH parameters. Values that appear are determined by what you enter during installation in the File Locations window of Oracle Universal Installer.

• NAME specifies home name of the Oracle home for IDx. This is the value that you specify during installation when prompted for an Oracle home name.
  
  
• PATH specifies Oracle home directory for IDx. Default value is ORACLE_BASE\ORACLE_HOME.

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 Performance Monitor for Windows NT
  
  
• Parameters for Oracle Services

Parameters for Oracle Performance Monitor for Windows NT

Oracle Performance Monitor for Windows NT parameters appear in HKEY_LOCAL_MACHINE\SYSTEM\CURRENTCONTROLSET\SERVICES\ORACLE9\PERFORMANCE.

For Oracle Performance Monitor to display information for Oracle 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 Performance Monitor for Windows NT will connect to. Default value is blank, causing Oracle 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 Corporation 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. Default value is MANAGER (encrypted).
  
  
• Username displays the username to access the database. Default value is SYSTEM.

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

• Close specifies the close entry point for the DLL. Default value is CloseOracle9PerformanceData.
  
  
• Collect specifies the collect entry point for the DLL. Default value is CollectOracle9PerformanceData.
  
  
• Library specifies the name of the Oracle Performance Monitor DLL. Default value is oraperf.dll
  
  
• Open specifies the open entry point for the DLL. Default value is OpenOracle9PerformanceData.

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

• LOGFILE specifies the name of the Oracle Performance Monitor log file. This log file reports any errors, such as Oracle objects not appearing or database access problems. Default value is ORACLE_BASE\ORACLE_HOME\dbs\operf90.log.
  
  
• PERF_FILE_NAME specifies the location of the perf.ora file, which contains all performance objects displayed by Oracle Performance Monitor. Default value is ORACLE_BASE\ORACLE_HOME\dbs\perf90.ora

Parameters for Oracle Services

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

Each service subkey contains the following parameters:

• DisplayName specifies the service name of the instance whose SID is SID. 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. 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. Default value is LocalSystem.

Oracle Real Application Clusters Registry Parameters

Oracle Real Application Clusters registry values are based on Oracle Corporation's Operating System Dependent (OSD) clusterware. If you are not using Oracle OSDs, then some of this information may not be applicable to your particular cluster environment.

Registry values are first listed and described (where necessary). Data types and default values are displayed in Table 9-1, " Oracle Real Application Clusters Registry Parameters"

HKEY_LOCAL_MACHINE\SOFTWARE\ORACLE\OSD9I

This subkey contains the following required and optional values:

• CMDLL specifies the full path of the Cluster Manager (CM) DLL.
  
  
• IODLL specifies the full path of the I/O DLL.
  
  
• IPCDLL specifies the full path of the Inter-Process Communication (IPC) DLL.
  
  
• STARTDLL specifies the full path of the Startup DLL.

HKEY_LOCAL_MACHINE\SOFTWARE\ORACLE\OSD9I\CM

This subkey contains Cluster Manager registry values. These values are updated when Oracle OSD clusterware is installed.

• ClusterID
  
  
• ClusterName
  
  
• CmDiskFile
  
  
• CmHostName is for public host names used by the local Cluster Manager. Useful in a multihost environment, when more than one network is available on the node.
  
  
• DefinedNodes specifies names for the nodes in a private network. Oracle OSD clusterware uses these addresses for its interconnect traffic.
  
  
• MissCount defines the number of check-in intervals that can be missed before a Cluster Manager and its related node are declared down by the cluster.
  
  
• PollInterval defines the check-in time among Cluster Managers on different nodes. Each Cluster Manager is expected to send at least one status packet to all other nodes for each poll interval.
  
  
• PublicNames specifies public node names in the public network (known as DNS host names).
  
  
• ServiceName

HKEY_LOCAL_MACHINE\SOFTWARE\ORACLE\OSD9I\IPC

This subkey contains Inter-Process Communication (IPC) registry values. These values are updated when Oracle OSD clusterware is installed.

• DeviceNic is for use with Virtual Interface Architecture (VIA) hardware. Nic refers to Network Interface Card.
  
  
• InstanceID contains VIA MAC addresses of all nodes.

Parameter Data Types and Default Values

Table 9-1  Oracle Real Application Clusters Registry Parameters

Parameter Name	Type	Default Value
CMDLL	REG_SZ	\winnt\system32\osd9i\cm.dll
IODLL	REG_SZ	\winnt\system32\osd9i\io.dll
IPCDLL	REG_SZ	\winnt\system32\osd9i\ipc.dll
STARTDLL	REG_SZ	\winnt\system32\osd9i\start.dll
ClusterID	REG_DWORD	0
ClusterName	REG_SZ	Oracle Cluster Manager 9I
CmDiskFile	REG_SZ	\\. \opsm
CmHostName	REG_SZ	hostname
DefinedNodes	REG_MULTI_SZ	hostname
MissCount	REG_MULTI_SZ	3
PollInterval	REG_DWORD	1000 (milliseconds)
PublicNames	REG_MULTI_SZ	hostname
DeviceNic	REG_SZ	nic0
InstanceID	REG_MULTI_SZ	not applicable

Modifying a Registry Value with regedt32

To edit Oracle-related settings:

1. Start Registry Editor in one of two ways:
   
   
   • From the command prompt, enter:
     
     

     C:\> regedt32
     
     

   • Choose Start > Run, enter regedt32 in the Open field, and click OK.

     Note: Use regedit to edit the registry on Windows 98. The dialog boxes for adding a registry parameter using regedit are slightly different from those for regedt32. See your Windows 98 documentation for specific instructions.

   The Registry Editor window appears.

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

3. Double-click the parameter to edit.

   The String Editor dialog box appears:

   

   Text description of the illustration stringre.gif

4. Make any necessary edits.
   
   
5. Click OK.
   
   
6. Choose Exit from the Registry Editor menu.

Adding a Registry Parameter with regedt32

To add a parameter to the registry:

1. Start Registry Editor in one of two ways:
   
   
   • From the command prompt, enter:
     
     

     C:\> regedt32
     
     

   • Choose Start > Run, enter regedt32 in the Open field, and click OK.

     Note: Use regedit to edit the registry on Windows 98. The dialog boxes for adding a registry parameter using regedit are slightly different than those described in the following steps for regedt32. See your Windows 98 documentation for specific instructions.

   The Registry Editor window appears.

2. Navigate to the key to which you want to add the new value.
   
   
3. Choose Add Value from the Edit menu.

   The Add Value dialog box appears:

   

   Text description of the illustration addvalue.gif

4. In the Value Name text box, type the name of the value that you want to add to the currently selected key.
   
   
5. 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
6. Click OK.

   The String Editor dialog box appears:

   

   Text description of the illustration stringre.gif

7. Type the value for the parameter.
   
   
8. Click OK.

   Registry Editor adds the parameter.

9. Choose Exit from the Registry Editor menu.

   Adding or Modifying Registry Parameters with Oracle Administration Assistant for Windows NT

   Instead of using regedt32 to add, edit, and delete parameters for an Oracle home, you can use Oracle Home Configuration snap-in, one of several snap-ins included as part of Oracle Administration Assistant for Windows NT. You must have Microsoft Management Console on your computer to use this product. Oracle home parameters are located in key HKEY_LOCAL_MACHINE\SOFTWARE\ORACLE\HOMEID.

   See "HKEY_LOCAL_MACHINE\SOFTWARE\ORACLE\HOMEID" for more information about Oracle home parameters.

   Starting Oracle Administration Assistant for Windows NT

   To start Oracle Administration Assistant for Windows NT:

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

      Oracle Administration Assistant for Windows NT starts.

   2. Expand Oracle Homes.
      
      
   3. Right-click the Oracle home that you want to modify.

      

      Text description of the illustration admin1.gif

   4. Click Properties. The Properties dialog box appears.

      

      Text description of the illustration admin2.gif

   Adding Oracle Home Parameters

   To add an Oracle home parameter:

   1. Click Add in the Properties dialog box.

      The Add Value dialog box appears.

      

      Text description of the illustration admin3.gif

   2. Enter the name in the Parameter Name text box.
      
      
   3. Enter the value in the Parameter Value text box.
      
      
   4. Click OK.
      
      
   5. Click Apply.

      Note: With Oracle Administration Assistant for Windows NT, you can add parameters only with a datatype of REG_SZ. Use regedt32 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 box. To edit one of the other parameters:

   1. Select the parameter in the Other Settings text box in the Properties dialog box.
      
      
   2. Click Edit.

      

      Text description of the illustration admin4.gif

      The Edit Value dialog box appears.

      

      Text description of the illustration admin5.gif

   3. Modify the value.
      
      
   4. Click OK.
      
      
   5. Click Apply.

   Deleting Oracle Home Parameters

   To delete an Oracle home parameter:

   1. Select the parameter in the Other Settings text box in the Properties dialog box.
      
      
   2. Click Delete.

   Modifying Oracle Performance Monitor for Windows NT Parameters

   Instead of using regedt32 to modify Oracle Performance Monitor's Hostname, Password, and Username parameters, you can use Oracle's OPERFCFG utility or Oracle Administration Assistant for Windows NT.

   See Also: "Parameters for Oracle Performance Monitor for Windows NT" for more information about Hostname, Password, and Username parameters

   
   
   

   Using OPERFCFG Utility

   OPERFCFG utility is an Oracle tool that you run from the command prompt. Use this syntax:

   operfcfg [-U username] [-P password] [-D database_name]
   
   

   where:

   • username is the username registry parameter value that Oracle Performance Monitor uses to log in to the database. You must have a DBA privilege on this database.
     
     
   • password is the password registry parameter value for username.
     
     
   • database_name is the net service name that Oracle Performance Monitor uses to connect to the database. It affects the Hostname registry parameter. The net service name corresponds to the SID of the database that you want to monitor. The -D command can be specified without providing a database name value.

   The -U, -P, and -D commands are all optional.

   The following examples illustrate use of OPERFCFG utility. First, to change username to dba_admin, password to frank, and leave database name at its current value, you would enter:

   C:\> operfcfg -U dba_admin -P frank
   
   

   To change username to dba_admin, password to frank, and database name to prod, you would enter:

   C:\> operfcfg -U dba_admin -P frank -D prod
   
   

   To change password to frank for the current username and database name, you would enter:

   C:\> operfcfg -P frank
   
   

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

   C:\> operfcfg -D
   
   

   Using Oracle Administration Assistant for Windows NT

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

   To use Oracle Performance Monitoring snap-in:

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

      Oracle Administration Assistant for Windows NT starts.

   2. Right-click Performance Monitor.
      
      
   3. Click Properties.

      The Performance Monitor Properties dialog box appears.

   4. Modify the text in the Username, Password, or Database text boxes.
      
      
   5. Click Apply.