Using an environment file to define Java options

Use the nco_g_bmc_remedy_v9.env environment file to define Java options that you want the Java Gateway for BMC Remedy ARS to pick up at run time.

Overview

The JRE_OPTS environment variable defined in the nco_g_bmc_remedy_v9.env file defines Java options specific to the Java Gateway for BMC Remedy ARS. The JRE_OPTS environment variable is supplied with Java options that define one system property: log4j.configuration. At start-up, the gateway picks up the contents of the JRE_OPTS environment variable.

The following sections discuss in more detail the nco_g_bmc_remedy_v9.env file and the log4j.properties file (which is used to configure the log4j logging package).

The nco_g_bmc_remedy_v9.env file

The nco_g_bmc_remedy_v9.env file supplied with the gateway resides in the $OMNIHOME/gates/bmc_remedy_v9 directory and contains an environment variable called JRE_OPTS. The JRE_OPTS environment variable is supplied with the following Java options that make use of the -D switch to define the following system property that gets executed at run time:

  • log4j.configuration

    This system property specifies the location and name (log4j.properties) of the properties file used to configure the log4j logging package that is distributed under the Apache Software License.

To define additional Java options specific to the gateway, add them to the JRE_OPTS environment variable in the nco_g_bmc_remedy_v9.env file.

The log4j.properties file

The purpose of the log4j.properties file is to set the level of the BMC Remedy ARS debug messages.

The log4j.properties file supplied with the Java Gateway for BMC Remedy ARS resides in the $OMNIHOME/gates/bmc_remedy_v9 directory and has the following properties (key-value pairs):

log4j.rootLogger=INFO  1 

The following list provides an explanation for the numbered item in the supplied log4j.properties file.

Note: The following description assumes an understanding of the format of a log4j.properties file.
  1. Specifies the debug level of the root logger as INFO.

    You can change the debug level to the standard log4j debug levels (for example, TRACE, WARN, and so forth). This change impacts the information that BMC Remedy ARS (not the gateway) prints.

    Note: The root logger sends BMC Remedy ARS (not gateway) output to the gateway log.