Overview
Environment variables are system settings that control the behavior of
various programs. Depending on where they are set, they can apply to a
particular user session or to all users on the system.
Omnidex requires several environment variables to be set in order to
function properly. Additionally, there are some optional variables that
can be set to alter Omnidex's behavior.
This section discusses all environment variables used by Omnidex, including
why, when and where to use them.
Required Environment Variables
These variables are required by Omnidex and must be set on the server
for Omnidex to function properly. All apply on all platforms unless otherwise
noted.
OAGLOBAL
OAGLOBAL points to the Omnidex Global Environment file, oaglobal.env.
This file is the global message file used by Omnidex. By default, it is
located in the root directory of the Omnidex server software.
Unix
export OAGLOBAL="/omnidex/oaglobal.env"
Windows
set OAGLOBAL=c:\omnidex\oaglobal.env
OMNIDEX_REG
OMNIDEX_REG points to the Omnidex registry file used for licensing. This
file is named odxreg (no file suffix), and is located in the root directory
of the Omnidex server software. odxreg is generated after the Omnidex
licensing information has been successfully entered. See your Server Setup
Guide for more details on licensing.
Unix
export OMNIDEX_REG="/omnidex/odxreg"
Windows
set OMNIDEX_REG=c:\omnidex\odxreg
OMNIDEX_LIBS
OMNIDEX_LIBS points to the Omnidex libraries and DLLs. This is the lib
directory on Unix and the bin directory on Windows, located in the root
directory of the Omnidex server software.
Unix
export OMNIDEX_LIBS="/omnidex/lib"
Windows
set OMNIDEX_LIBS=c:\omnidex\bin
OMNIDEX_HOME
OMNIDEX_HOME points to the root directory of the Omnidex server software.
Unix
export OMNIDEX_HOME="/omnidex"
Windows
set OMNIDEX_HOME=c:\omnidex
PATH
PATH points to the directory where the Omnidex executables reside. This
variable is a system variable, not Omnidex specific. The system PATH variable
is likely to contain other paths. Be sure not to override the existing
setting by appending the Omnidex executable path to the end of the existing
setting.
If the PATH is not set, users will either be required to run all Omnidex
executables from the directory in which the executable resides or must
pass the fully qualified path to the executable.
Unix
export PATH="/omnidex/bin:$PATH"
Windows
set PATH=%PATH%;c:\omnidex\bin
LD_LIBRARY_PATH
LD_LIBRARY_PATH points to the directory where shared libraries reside.
This variable is a system variable, not Omnidex specific. LD_LIBRARY_PATH
is a Unix only environment variable.
Unix
export LD_LIBRARY_PATH="/omnidex/lib"
TMPDIR (Unix) / TEMP & TMP (Windows)
TMPDIR, TEMP and TMP point to a temporary directory where Omnidex temporary
files, including DBINSTAL scratch (unload) files, are built. TMPDIR is
a Unix system variable and TEMP and TMP are Windows system variables.
These variables are not Omnidex specific.
Unix
export TMPDIR="/temp"
Windows
set TMPDIR=c:\temp
set TEMP=c:\temp
set TMP=c:\temp
Recommended Environment Variables
The following variables, although not required for all installations,
are either highly recommended or required for certain applications, as
noted.
CLASSPATH
CLASSPATH points to the directory where the omnidex.jar file resides
and is required for Java development on all platforms. The system CLASSPATH
variable is likely to contain other paths. Be sure not to override the
existing setting by appending the Omnidex executable path to the end of
the existing setting.
omnidex.jar is located in the bin subdirectory of the Omnidex root directory
on the server, and in the lib subdirectory of the Omnidex Client root
directory on the client machine.
Unix
export CLASSPATH="/omnidex/bin/omnidex.jar:$CLASSPATH"
Windows
set CLASSPATH=%CLASSPATH%;c:\omnidex\bin\omnidex.jar
OMNIDEX_ADDIN
OMNIDEX_ADDIN controls whether the addin is active. The Omnidex Addin
provides an additional layer of functionality in SQL processing not available
through OmniAccess alone. Values are ON or OFF.
Unix
export OMNIDEX_ADDIN=ON
Windows
set OMNIDEX_ADDIN=ON
Top
|