Stat 6.3 - System Administration Guide

Miscellaneous

Appendix: stat.conf Configuration

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.

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.

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.

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.

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

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.”

(optional parameter)

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

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> environment file name (filename only) (Optional for R12 and R12.1)

<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> temporary directory. Used to temporarily store generated forms. (Optional for R12 and R12.1)

<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.

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:

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.

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

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

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).

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)

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

<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.

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.

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.

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'

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'.

The following preprocessors are passed to SQLPlus by default:

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

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

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.

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)

(optional parameter)

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

(optional parameter)

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

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.

(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.

Naming Context for JBoss Application Server

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

The name of the file where log information is written.

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.

(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.

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.

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

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).

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).

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

(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.

(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

NOTE: This parameter is applicable before an event is processed, while the parameter <env>.event_timeout is applicable after an event is processed.

If migration order is used for objects in a multi-node environment, an agent may have to wait for other agents to finish processing objects with a lower migration order. This parameter defines the number of minutes an agents wait for other agents. Default is 15 minutes.

(optional parameter)

This parameter defines the logical servername for <ENV> environment. When this parameter is not used, the Stat Oracle Agent uses the physical servername and environment code to identify itself with the Stat repository. This parameter can be used with HA architectures that require a virtual hostname.

When set (envCode.sqlplus_options:-s), enables the agent to use sqlplus to execute sql scripts and packages.

When applying E-Business patches, all services will be stopped before the patch apply starts. Stat will wait for a response from each server indicating it is down. This parameter indicates the amount of time Stat should wait for services to shutdown. If that time is exceeded without response from the service, Stat will assume that it is down.

A comma-separated list of file objects for which generation will be skipped. Valid values are:

When compiling package headers, package bodies, PLS objects, or SQL Scripts, a SHOW ERRORS is pasted to the end of the script. If user wants to skip this step, they can set this parameter to “Y.”

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

This parameter defines the upload mode for Oracle's WFLOAD utility when migrating WFT files. The value can be set to UPGRADE (default), UPLOAD or FORCE.

UPGRADE - Customizations to seed workflow data is preserved. Only process definitions that have not been previously customized are loaded.

UPLOAD - WFLOAD will use the access levels specified in the WFT file when uploading the workflow.

FORCE - The entire workflow definition will be loaded, regardless of an object's protection level.

Determines how the Stat Oracle Agent handles a lost connection with the Stat Central Agent. No events are lost when the connection is lost.

Retry - When set to “retry”, the Stat Oracle Agent attempts to re-establish the connection to the Stat Central Agent every 10 seconds indefinitely. The agent can be shutdown at anytime using statctl.sh.

Terminate (default) - When set to “terminate”, the Stat Oracle Agent immediately terminates when the connection to the Stat Central Agent is lost. This is the default process if the parameter is not set or is invalid.

JNDI port of the Stat Central Agent server. If JBoss is used as the application server, 1099 is the default naming port. If the application server is configured for a different naming port, the Oracle Agent should be updated with the correct port.

Server or IP hosting the Stat Central Agent server.

(optional parameter)

Stat Repository database name. For Oracle, this is the service name.

(optional parameter)

The JDBC driver class name for the Stat Repository. This parameter must be set to “oracle.jdbc.driver.OracleDriver” since Oracle is the only supported database platform for the agent. Note the class does not include a “com.” prefix.

NOTE: This parameter is optional except in the case of NATTED environments, in which case it is required and should be the IP address.

(optional parameter)

Stat Repository database password.

NOTE: This parameter is in clear text and can be removed.

(optional parameter)

Stat Repository database listener port.

NOTE: This parameter is optional except in the case of NATTED environments, in which case it is required.

(optional parameter)

Stat Repository server name.

NOTE: This parameter is optional except in the case of NATTED environments, in which case it is required.

(optional parameter)

Stat Repository database username.

NOTE: This parameter is optional except in the case of NATTED environments, in which case it is required.

(optional parameter)

Running protocol for Stat Central Agent. By default the running protocol is http. If Stat Central Agent is running on https, this parameter needs to be set to https.

Appendix: Custom Report Files

Appendix J describes how use Jaspersoft Studio, a 3rd party reporting tool, to format the .jrxml files used to create Stat reports. It is not intended to be a comprehensive how-to guide; Instead, it points out required items and offers tips to make designing reports easier.

About Stat Report Files

All Stat reports are created with a tool called Jaspersoft Studio. This is a GUI based tool that allows you to format your report and store it in a .jrxml file. Although some knowledge of XML may be necessary to handle the finer details, Jaspersoft Studio does most of the formatting work for you. It is available at http://sourceforge.net/projects/jasperstudio/files/JaspersoftStudio-6.1.1/ at no charge. All Stat reports were created with Jaspersoft Studio 6.1.1. We suggest using the same version of Jaspersoft Studio or set the compatibility version to 6.1.1.

You may copy a Stat report that contains embedded SQL as a starting point for designing you own report. When creating a report, be aware of the following: