Bookshelf v7.5: About Working in the Registry

Siebel Analytics Web Administration Guide > Administering Siebel Analytics Web >

About Working in the Registry

The registry contains information about the configuration of a computer, including the settings of programs installed on it. The operating system continually references the registry while the machine is running.

Several Siebel Analytics Web registry entries are created during the installation process. You can customize Siebel Analytics Web by modifying these entries and adding new entries.

CAUTION: Use extreme care when you modify the registry. Always back up the entire registry, or the registry keys that you plan to work on, before you make any changes.

Starting the Windows Registry Editor

You start the Windows Registry Editor using the Run command.

To start the Windows Registry Editor

From the Start Menu, select Run.

In the text box, type regedit.

Figure 1 shows a number of registry keys for Siebel Analytics in the left pane of the Windows Registry Editor.

Figure 1.  Registry Keys and Entries Created During Installation

In this book, the registry keys and entries are described as the path to the key followed by the entry name. The selected key in Figure 1 is the 7.5 key, which has three entries:

Default, the entry for the key itself.

HKEY_LOCAL_MACHINE\SOFTWARE\Siebel Systems, Inc.\Siebel Systems, Inc.\Siebel Analytics\Web\7.5

(Default)

CatalogPath, the path for the Siebel Analytics Web Catalog:

HKEY_LOCAL_MACHINE\SOFTWARE\Siebel Systems, Inc.\Siebel Systems, Inc.\Siebel Analytics\Web\7.5

CatalogPath

DSN, the name of the Siebel Analytics Server data source name used by Siebel Analytics Web to access the Analytics server.

HKEY_LOCAL_MACHINE\SOFTWARE\Siebel Systems, Inc.\Siebel Systems, Inc.\Siebel Analytics\Web\7.5

DSN

Opening the UNIX Registry Editor

The UNIX operating system does not have a registry like the Windows registry. However, the Siebel Analytics Web software includes a third-party registry implementation tool for UNIX machines. When used in graphical user interface mode, it allows a UNIX administrator to customize the operating characteristics of Siebel Analytics Web running on a UNIX machine in the same manner as a Windows administrator performs customization for a Windows machine. It can also be run as part of a script.

For information about the entries you can make to customize Siebel Analytics Web, see To open the UNIX Registry Editor.

NOTE: The registry entry examples given in this book assume that you are editing a Windows registry, so make any necessary substitutions in terms of file system paths, and add double quotes around registry entry values. For example, in the Windows environment, the value for the CatalogPath registry entry is: C:\SiebelAnalyticsData\Web\Catalog\default.webcat. In the registry implementation on UNIX, the equivalent entry is: /usr/local/SiebelAnalytics/default.webcat.

To open the UNIX Registry Editor

To open the UNIX Registry Editor, use the regedit command.

Entering regedit without any parameters opens the Registry Editor window.

Figure 2 shows the Registry Editor window in UNIX.

Figure 2.  The Registry Editor Window in UNIX

You can also use switches entered with this syntax (see Table 3 for details):

regedit [-c] [-e] [<file.reg>] [registry key]

Table 3.  Regedit Syntax

Switch

Function

c

Omit this to use the graphical user interface mode.

This indicates console mode. No X terminal is required. This is useful if you want to run a script to populate the registry entries.

e

Indicates export mode. When a value for <file.reg> is supplied, the default mode is import mode unless this switch is set. When you have finished modifying the registry, use this switch to merge your changes into the registry.

file.reg

The name of the registry file to edit.

Use a descriptive name, such as sa-web.reg.

registry key

The customization option that you want to use, for example:

CatalogPath "/users/Web/Catalog/default.nqwcat"

Use the paths given in Siebel Analytics Web Administration Guide and make the necessary substitutions for UNIX syntax.

It is recommended that you use the graphical user interface mode (see Table 3) until you are familiar with adding entries. This requires that you use a terminal that has X Window, or a similar screen editor, available.

Examples of Entries in the UNIX Registry Editor

This command opens the Registry Editor window. Navigate to HKEY_LOCAL_MACHINE_SOFTWARE/Software/SiebelAnalytics Software/Web/7.5 and start adding entries.

regedit

This command merges the registry file sa-web.reg into the UNIX registry.

regedit sa-web.reg

This command with the -e option is meant to indicate export mode; it exports the given registry key to a file.

regedit -e HKEY_LOCAL_MACHINE

This command merges the registry file sa-web.reg into the UNIX registry. It uses console mode. This command could be used in a script or makefile.

regedit -c sa-web.reg

Table 3. Regedit Syntax
Switch	Function
c	Omit this to use the graphical user interface mode. This indicates console mode. No X terminal is required. This is useful if you want to run a script to populate the registry entries.
e	Indicates export mode. When a value for <file.reg> is supplied, the default mode is import mode unless this switch is set. When you have finished modifying the registry, use this switch to merge your changes into the registry.
file.reg	The name of the registry file to edit. Use a descriptive name, such as `sa-web.reg`.
registry key	The customization option that you want to use, for example: `CatalogPath "/users/Web/Catalog/default.nqwcat"` Use the paths given in Siebel Analytics Web Administration Guide and make the necessary substitutions for UNIX syntax.

Siebel Analytics Web Administration Guide
Published: 18 April 2003