Environment Variables
Your application uses several environment variables to determine where information is stored and to be placed for its internal operations. Becoming familiar with these variables will assist you in finding information quickly and efficiently.
Note:
If a custom script is written to access or write information to the product functionality, it is highly recommended that the following variables be referenced in your scripts. This is to maximize the chance that your script will remain functional across upgrades.The following table outlines some of the key environment variables:
| Variable | Usage |
|---|---|
| ANT_ADDITIONAL_OPT | Options for ant in accordance with the configuration settings at installation time. |
| ANT_HOME | Location of ant build utilities. |
| ANT_OPTS | Options for ant for Oracle SDK. |
| ANT_OPT_MAX | Maximum memory settings for ant in accordance with the configuration settings at installation time. |
| ANT_OPT_MIN | Minimum memory settings for ant in accordance with the configuration settings at installation time. |
| CMPDB | Database Type (ORACLE). |
| DBNAME | Database Name. |
| ENVFILE | Location and name of environment configuration file. |
| HOSTNAME | Name of host (fully qualified). |
| JAVA_HOME | Location of JDK. |
| LD_LIBRARY_PATH | Library Path. |
| NLS_DATE_FORMAT | Oracle NLS Date Format. |
| NLS_LANG | Oracle NLS Language string. |
| NLS_SORT | Oracle NLS Sorting. |
| ONLINEBILLINI | Location of document rendering software template building configuration files. |
| ONLINEDOCINI | Location of document rendering software configuration files. |
| OPSYS | Operating System Name. |
| OPSYSINFO/OPSYSVER | Operating System Version. |
| ORACLE_CLIENT_HOME | Location of the Oracle Client software (used for location of perl). If full Oracle Database software is installed on the host this value will match ORACLE_HOME. |
| ORACLE_HOME | Location of the DBMS software. |
| OSTYPE | Operating System Type. |
| PERL5LIB/PERLIB | Location of Perl Libraries. |
| PERL_HOME | Location of Perl. |
| SERVER_ROLES | Roles enable for this server. |
| SERVER_ROLE_BATCH | Whether the batch server is included. |
| SERVER_ROLE_INTEGRATION | Whether the integration server is included. |
| SERVER_ROLE_ONLINE | Whether the online server is included. |
| SPLADMIN | Administration user ID. |
| SPLADMINGROUP | Administration group. |
| SPLApp | Name of root web application WAR file. |
| SPLAPP | See SPLOUTPUT. |
| SPLBCKLOGDIR | Location of backups of online log files (must be set manually). |
| SPLEBASE | Location of software for environment. |
| SPLENVIRON | Name of environment. |
| SPLOUTPUT | Location of output for environment. |
| SPLRUN | Location of runtime for environment. |
| SPLSDKROOT | Location of SDK (Development environment only). |
| SPLSYSTEMLOGS | Location of product specific logs. |
| SPLVERSION | Version identifier of product (prefixed with V). |
| SPLVERSION_NUM | Version number of product. |
| WEB_ISEXPANDED | Whether web application is expanded or not (not = WAR/EAR files). |
| WEB_SERVER_HOME | Location of web application server software. |
| WL_HOME | Location of Oracle WebLogic installation (WebLogic supported platforms only). |
Note:
If a custom script is written to access or write information to the product functionality, it is highly recommended that the following variables be referenced in your scripts. This is to maximize the chance that your script will remain functional across upgrades.Note:
HIBERNATE_JAR_DIR is used for the installation process only. After installation is complete the jar files located at the locations specified by these environment variables are copied to the correct locations for execution.
Note:
Additional variable may be created by various operating system and product utilities. The list above constitutes the non-temporary variables.