Environment Variable Configuration Properties

You can specify additional environment variables for the Oracle HTTP Server using environment properties such as SHELL, LANG, INSTANCE_NAME, and more.

The environment property syntax is:

environment[.append][.<order>].<name> = <value>

Where:

  • The optional .append will append the new <value> to any existing value for <name>. If <name> has not yet been defined, then <value> will be the new value.

  • The optional .<order> value sets order for this definition's setting in the environment (the default is 0). The order determines when the configured variable is added to the process' environment (and its value evaluated). Environment properties with lower order values are processed before those with higher order values. The order value must be an integer with a value greater than or equal to 0.

  • <name> is the environment variable name, which must begin with a letter or underscore, and consist of letters, numeric digits or underscores.

  • <value> is the value of environment variable <name>. The value can reference other environment variable names, including its own.

    The following special references may be included in the value:

    • "$:" for the path separator

    • "$/" for the file separator

    • "$$" for '$'

With the exception of these special characters, UNIX variable syntax references ("$name" or "${name}") and the Windows variable syntax reference ("%name%") are supported.

Each property name within the same property file must be unique (the behavior is not defined for multiple properties defined with the same name), thus the .<order> field is necessary to keep property names unique when multiple definitions are provided for the same environment variable <name>.

The following environment variables are set by the Oracle HTTP Server plug-in:

  • SHELL: From 's environment, or defaults to /bin/sh, or cmd.exe for Windows

  • ORA_NLS33: Set to $ORACLE_HOME/nls/data

  • NLS_LANG: From 's environment, otherwise default

  • LANG: From 's environment, otherwise default

  • LC_ALL: From 's environment, if set

  • TZ: From 's environment, if set

  • ORACLE_HOME: Full path to the Oracle home

  • ORACLE_INSTANCE: Full path to the domain home

  • INSTANCE_NAME: The name of the domain

  • PRODUCT_HOME: The path to the Oracle HTTP Server install: $ORACLE_HOME/ohs

  • PATH: Defaults to

    • On UNIX:

      $PRODUCT_HOME/bin:$ORACLE_HOME/bin:

      $ORACLE_HOME/jdk/bin:/bin:/usr/bin:/usr/local/bin

    • On Windows:

      %PRODUCT_HOME%\bin;%ORACLE_HOME%\bin;

      %ORACLE_HOME%\jdk\bin;%SystemRoot%;%SystemRoot%\system32

These variables apply to UNIX only:

  • TNS_ADMIN: From 's environment, or $ORACLE_HOME/network/admin

  • LD_LIBRARY_PATH: $PRODUCT_HOME/lib:$ORACLE_HOME/lib:$ORACLE_HOME/jdk/lib

  • LIBPATH: Same as LD_LIBARY_PATH

  • X_LD_LIBRARY_PATH_64: Same as LD_LIBRARY_PATH

These variables apply to Windows only:

  • ComSpec: Defaults to %ComSpec% value from the system.

  • SystemRoot: Defaults to %SystemRoot% value from the system.

  • SystemDrive: Defaults to %SystemDrive% value from the system.

Example

On a UNIX like system with the web tier installed as /oracle and the environment variable "MODX_RUNTIME=special" set in the NodeManager's environment, the following definitions:

environment.MODX_RUNTIME = $MODX_RUNTIME
environment.1.MODX_ENV = Value A
environment.1.MODX_PATH = $PATH$:/opt/modx/bin
environment.2.MODX_ENV = ${MODX_ENV}, Value B
environment.append.2.MODX_PATH = /var/modx/bin
MODX_ENV = Value A, Value B
MODX_PATH = /oracle/ohs/bin:/oracle/bin:/oracle/jdk/bin:/bin:/usr/bin: /usr/local/bin:/opt/modx/bin:/var/modx/bin

would result in the following additional environment variables set for Oracle HTTP Server:

MODX_RUNTIME = special