Stat 6.1 - System Administration Guide

The stat_ora.zip file includes a default stat.conf file, which after installation is located in the user’s home directory under <STAT_HOME>/conf. All the mandatory parameters and most commonly used parameters are included in this default configuration file. The value for some of these parameters will need to be updated. Additional parameters listed in this section may not be included in the default stat.conf file and, if applicable, will need to be defined by the user. The syntax for all parameters is name:value pair. Comments begin with a “#” character and end with the end of the line.

The following table lists all valid parameters. Some parameters apply to all instances of an agent (e.g. parameters to identify the Stat Repository), while others apply to each instances of an agent (e.g. parameters specific for an Oracle E-Business Suite environment).

Parameters prefixed with “stat” apply to all instances of an agent and should only be defined once in the configuration file. Parameters prefixed with <ENV> refer to an instance of the Stat Oracle Agent for a particular Oracle E-Business Suite environment. The <ENV> must be replaced with the environment code used to define that Oracle E-Business Suite environment in Stat.

When the Stat Oracle Agent is started, the stat.conf configuration parameters are cached in memory. You need to restart the agent before a parameter change can take effect.

<ENV>.adadmin_timeout 271

<ENV>.admin_port 272

<ENV>.autopatch_timeout 272

<ENV>.command_timeout 272

<ENV>.db_init_sql 272

<ENV>.DB_ORACLE_HOME 272

<env>.env.ADOP_LOG_PATTERN 272

<ENV>.env.APPLFENV 272

<ENV>.env.APPLREP 272

<ENV>.env.APPLTMP 272

<ENV>.env.APPL_TOP 272

<ENV>.env.<BaseDirCode> 273

<ENV>.env.CONTEXT_FILE 273

<ENV>.env.CONTEXT_NAME:<sid_hostname> 273

<ENV>.env.CUSTOM_OAF_DIR 273

<env>.env.CUSTOM_PRODUCTS 273

<ENV>.env.JAVA_TOP 273

<ENV>.env.NLS_LANG 273

<ENV>.env.ORACLE_HOME 273

<ENV>.env.<parameter> 274

<ENV>.env.PLSQL_ERROR_EXPRESSION 274

<ENV>.env.<ProductCode> 274

<ENV>.env.set_escape_processing 274

<ENV>.env.SHARED_PRODUCTS 274

<env>.env.ssh_disabled 274

<ENV>.env.SQLPLUS_PREPROCESSORS 274

<ENV>.env.USE_DATABASE_CHARACTERSET 275

<ENV>.env.TWO_TASK 275

<ENV>.env.XMLIMPORTER_OPTIONAL_PARMS 275

<ENV>.env.XMLEXPORTER_OPTIONAL_PARMS 275

<ENV>.event_processors 275

<ENV>.event_timeout 275

<ENV>. java.naming.factory.initial 275

<ENV>.log.file 276

<ENV>.log.level 276

<ENV>.log.directory 276

<ENV>.log.pattern 276

<ENV>.log.rolling.frequency 276

<ENV>.log.rolling.size 276

<ENV>.log.rolling.type 276

<ENV>.maintmode_script 277

<ENV>.maintmode_timeout 277

<ENV>.migration_order_timeout 277

<ENV>.servername 277

<ENV>.sqlplus_options 277

<ENV>.shutdown_services_timeout 277

<ENV>._skip_object_generation 277

<ENV>.skip_show_errors 278

<ENV>._sqlplus_timeout 278

<ENV>.WFLOAD.upload_mode 278

stat.central_agent.disconnect_action 278

stat.central_agent.name_port 278

stat.central_agent.server 278

stat.db.name 278

stat.db.jdbc_driver 279

<ENV>.adadmin_timeout

Minutes the Stat Oracle Agent will wait for an adadmin command to produce an output. The Stat Oracle Agent will fail the Adadmin session if the inactivity (i.e., no output) exceeds this parameter. Default is 5 minutes.

<ENV>.admin_port

Port on local server for administering the Stat Oracle Agent processes for <ENV> Oracle E-Business Suite environment. Any unused port greater than 1024 can be used (e.g., 5501, 5502). The parameter for each environment on the server must be unique.

<ENV>.autopatch_timeout

Minutes the Stat Oracle Agent will wait while monitoring AutoPatch activity. The Stat Oracle Agent will fail the AutoPatch session if the inactivity (i.e., no output) exceeds this parameter. Default is 5 minutes. Larger patches may require up to 15 minutes.

<ENV>.command_timeout

This timeout is used when an internal command processor is run to execute commands. Default is 5 minutes.

<ENV>.db_init_sql

This parameter can be set to an anonymous PL/SQL block. When the Oracle Agent connects to the Oracle Apps database, this anonymous PL/SQL block will be executed to initialize the connection. This is useful to initialize a database session. For example, if the database language in not American English: “<env>.db_init_sql:declare begin dbms_session.set_nls('nls_language', 'AMERICAN') end.”

<ENV>.DB_ORACLE_HOME

(optional parameter)

Configures the Stat Oracle Agent to use the specified path for sqlplus.

<env>.env.ADOP_LOG_PATTERN

Default pattern for capturing Patch logs is "(.*\\.log)|(.*\\.lgi), meaning all files with .log and .lgi extensions. Users may add other extension by changing the regular expression. For example to additionally capture files with .out extension change the pattern to (.*\\.log)|(.*\\.lgi)|(.*\\.out)

<ENV>.env.APPLFENV

<ENV> environment file name (filename only) (Optional for R12 and R12.1)

<ENV>.env.APPLREP

<ENV> reports directory. This parameter should be set to “reports”, unless the default reports directory name has been changed. (Optional for R12 and R12.1)

<ENV>.env.APPLTMP

<ENV> temporary directory. Used to temporarily store generated forms. (Optional for R12 and R12.1)

<ENV>.env.APPL_TOP

<ENV> APPL_TOP directory for server. (Optional for R12 and R12.1)

Directory for the base directory code used with generic file types. For more information, see the section, “Object Compare Support for Form Library Files” in the Install Guide.

<ENV>.env.CONTEXT_FILE

The Oracle Agent resolves product top environment variables using the context file defined by this parameter. The context file is an XML file used by AutoConfig normally located in the $APPL_TOP/admin directory. The parameter value should be a fully qualified file name for the context file. When the agent needs the value for a product top variable, it checks the following in the order listed:

•

The <env>.env.<productTop> parameter in the stat.conf configuration file for the Oracle Agent.

•

If the <env>.env.CONTEXT_FILE agent configuration parameter is set, the value is parsed from the context file.

•

The environment file defined by the <env>.env.APPLFENV agent configuration parameter is parsed for the value.

•

The adovars file is parsed for the value.


	NOTE: This parameter is optional for Release 12 and recommended for 11.5.10 and higher since the environment file will no longer explicitly set product top variables.

<ENV>.env.CONTEXT_NAME:<sid_hostname>

sid_hostname is the usually configuration for this value. Yours may be different. Ask your DBA

<ENV>.env.CUSTOM_OAF_DIR

This parameter is used to support OAF object types and is set to the name of the custom directories (example: XXQuest,XXQUEST).

<env>.env.CUSTOM_PRODUCTS

For R12.2, when a custom top is created using adsplice, a new Product's status is not set to 'L'. This parameter keeps track of custom products. Value is a comma separated list of custom products, for example (XXQuest,XXQUEST).

<ENV>.env.JAVA_TOP

This parameter is used to support OAF object types and is set to the value of $JAVA_TOP variable on the environment. (Optional for R12 and R12.1; not used in R12.2)

<ENV>.env.NLS_LANG

This parameter defines the NLS_LANG environment variable for the Oracle Agent. NLS_LANG is only used for archiving and migrating AK objects.

<ENV>.env.ORACLE_HOME

<ENV> Oracle Home for Oracle Developer.(Optional for R12 and R12.1)

When defining new Custom Object types, users may also define a Generation command to be run at the end of migration.

If a user needs to pass a user-defined environment parameter to the Generation command, they may do so by defining that parameter in Stat.conf.

<ENV>.env.PLSQL_ERROR_EXPRESSION

When compiling file objects using SQLPlus, we looks for the expression 'Warning: (.*) created with compilation errors.' in order to capture any possible errors. Customer may use this parameter to change the value of this expression.

For example, if user needs to pass a version number, they will enter %%VERSION%% in the Generation command, and they will define an <ENV>.env.VERSION:1.2 in stat.conf.

Directory for a product top. This parameter can be used to define the top directory for custom products. Additionally, this parameter can be used for standard products when the context file is not used and product tops are not defined explicitly in the environment file. For more information, see the section, “Custom Products and File Locations” in the Install Guide.

<ENV>.env.set_escape_processing

By default Escape Processing is set to false for Oracle agent. If for any reason customer needs to set this option to true, they may use < env>.env.set_escape_processing:Y.

<ENV>.env.SHARED_PRODUCTS

If a product is a shared product but is listed on the E-Business product table as not installed (N), the product can be added to the stat.conf file. Use commas to list separate products.

Example: <ENV>.env.SHARED_PRODUCTS:'JA','JE'

<env>.env.ssh_disabled

In a Multi-node environment, by default, Stat assumes that the ssh utility is running between the Admin node and all other nodes. To override this, set this parameter to 'n'.

<ENV>.env.SQLPLUS_PREPROCESSORS

The following preprocessors are passed to SQLPlus by default:

SET VERIFY OFF

WHENEVER SQLERROR EXIT FAILURE ROLLBACK;

WHENEVER OSERROR EXIT FAILURE ROLLBACK;

Customers may use this parameter if they need to change this list. For example:

<env>.env.SQLPLUS_PREPROCESSORS:SET DEFINE OFF\n WHENEVER SQLERROR EXIT FAILURE ROLLBACK;\n WHENEVER OSERROR EXIT FAILURE ROLLBACK;\n SET LINESIZE 999\n

Customers may also ignore the passing of any preprocessors by setting the value of this parameter to no value. For example:

<env>.env.SQLPLUS_PREPROCESSORS:

<ENV>.env.USE_DATABASE_CHARACTERSET

When archiving a multi-language aol record, the database character set is used. The database has to use UTF8 or AL32UTF8 character set or the archive will not have correct characters in it.

By default we use the database character set using the following query:

select value from NLS_DATABASE_PARAMETERS where parameter=”NLS_CHARACTERSET”;

users can disable this by setting this parameter to “N.” For example, <env>.env.USE_DATABASE_CHARACTERSET:n)

In this case we will use the characterset specified in fnd_languages_vl view.

<ENV>.env.TWO_TASK

If your DBA has set the two_task variable, enter it here. This is typically a DB instance name. (Optional for R12 and R12.1)

<ENV>.env.XMLIMPORTER_OPTIONAL_PARMS

(optional parameter)

This parameter is used to support OAF object types and is used to pass extra parameters to XMLImporter commands.

<ENV>.env.XMLEXPORTER_OPTIONAL_PARMS

(optional parameter)

This parameter is used to support OAF object types and is used to pass extra parameters to XMLExporter commands.

<ENV>.event_processors

Number of <ENV> message processing threads for non-patch requests. This parameter controls the degree of concurrency for processing events. Recommended initial value is 2.

<ENV>.event_timeout

(optional parameter)

If maintenance mode is used when applying patches, rolling back patches or migrating custom objects in multi-node environments, an agent will wait until all other agents have finished processing the event before maintenance mode is disabled. This parameter defines the number of minutes an agent will wait before failing the event. If this parameter is not defined, the default is 60 minutes.


	NOTE: This parameter is applicable after an event has been processed, while the parameter <env>.maintmode_timeout is applicable before processing an event.

<ENV>. java.naming.factory.initial

Naming Context for JBoss or WebLogic Application Servers

For JBoss: java.naming.factory.initial=org.jnp.interfaces.NamingContextFactory

For WebLogic: java.naming.factory.initial=weblogic.jndi.WLInitialContextFactory.

<ENV>.log.file

The name of the file where log information is written.

<ENV>.log.level

Level of detail logged by Stat Oracle Agent for <ENV> Oracle E-Business Suite environment. Set this parameter to one of the following values: off, fatal, error, warn, info, detail, verbose or trace. Levels are cumulative and listed in degree of detail printed in log file (i.e. “error” includes all log records for “fatal” as well as some additional records). A value of “info” is suggested.


	NOTE: Performance is impacted modestly with each increase in the logging level. Levels with high degree of logging (e.g. trace) should only be used during the initial deployment and troubleshooting to minimize performance impact.

<ENV>.log.directory

(optional parameter)

If this parameters is not defined, the agent writes to the log in the <STAT_HOME>/log directory. If defined, the agent writes to the log in the directory specified by the parameter. The fatal.err file will continue to be written to the <STAT_HOME>/log directory.

<ENV>.log.pattern

Format mask of the log file records for <ENV> Oracle E-Business Suite environment.

Following is an example value that captures the date and message for each log record.

%d{yyyy-MM-dd HH:mm:ss} - %m%n

Following is an example value that captures additional detail, such as the class, line number and thread, for each record.

%d{yyyy-MM-dd HH:mm:ss} %20F:%4L %15t - %m%n

<ENV>.log.rolling.frequency

This parameter defines the frequency which the log file is archived when the <ENV>.log.rolling.type parameter is set to “frequency.” The value can be set to daily (default), weekly or monthly.

daily - The log file will be archived at midnight each day. The archived file will include a file extension with the current year-month-day (e.g. 2004-05-07).

weekly - The log file will be archived at midnight the first day of each week. The archived file will include a file extension with the current year-week (e.g. 2004-23).

monthly - The log file will be archived at midnight the first day of each month. The archived file will include a file extension with the current year-month (e.g. 2004-05).

<ENV>.log.rolling.size

This parameter defines the size of the log file (in bytes) before it will be archived. When the size of the log file reaches the size defined by this parameter, it will be archived to a new file with “.1” extension. The value must be an integer in the range 0 to 2^63 (default is 10MB).

<ENV>.log.rolling.type

Valid values are size or frequency and user should be refer to those 2 options for more detail.

<ENV>.maintmode_script

(optional parameter)

This parameter can be used to specify a script to enable/disable maintenance mode. The Oracle Agent on the database server will pass a single parameter, “ENABLE” to enable maintenance mode and “DISABLE” to disable maintenance mode. If the script specified by this parameter has a “.sql” file extension, it will be executed with sqlplus. Otherwise, the script specified by this parameter will be executed as a command. If this parameter is not defined, the Oracle Agent will use the FND_APPS_MODE_UTIL package by default to enable/disable maintenance mode.


	NOTE: Only the agent on the database server will enable/disable maintenance mode. In multi-node environments, the other agents monitor the profile option Applications Maintenance Mode to determine the state for the environment.

<ENV>.maintmode_timeout

(optional parameter)

In multi-node environments, only the Stat Oracle Agent on the database server will enable/disable maintenance mode. However, all agents will wait until maintenance mode is enabled before processing the request. This parameter defines the number of minutes agents will wait before failing the request. If this parameter is not defined, the default is 5 minutes