Stat 7.0 - System Administration Guide


Problem	Explanation/Solution
When changing the printer (File \| Print Setup) to generic text only, the font for the open description on CSRs changes to Roman 10cpi. This is the only available font listed until changing the printer back and re-opening the CSR.	Unfortunately, Stat has no control over font displays. This is a function of Windows. Similar behavior occurs in Microsoft Word.
Receive the following error message from the Stat Central Agent when printing a scheduled report “-9 error opening print job in Stat Central Agent scheduled report”	Verify that the printer to which you are trying to print your scheduled job exists on the machine where the Stat Central Agent is running. Also verify that the Host Printer name on the Stat Central Agent matches the printer name on the machine. For more information on the Stat Central Agent Printers, see Chapter 6, Configuring the Stat Central Agent .

Miscellaneous


Problem	Explanation/Solution
User Class Security: I would like to configure my service domains in such a way that HR dept. users cannot view FIN dept. users' CSRs and vice versa, even though they are all members of the same service domain.	The only way to do this is to set up two service domains; one for HR and one for FIN. This way, they cannot view each other's CSRs. If you have some users who need to view CSRs from both service domains, you can configure this at the user ID level; e.g., give user X access to both service domains. For information on granting access to multiple service domains, please see Stat Security .

Appendix: Oracle Agent: Stat.conf and log4j2.xml configuration

The stat_ora.zip file includes a default stat.conf file and log4j2.xml file, which after installation are located in the user's home directory under STAT_HOME>/conf. All the mandatory parameters and most commonly used parameters are included in these default configuration files. 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 304

<ENV>.admin_port 304

<ENV>.autopatch_timeout 305

<ENV>.command_timeout 305

<ENV>.db_init_sql 305

<ENV>.DB_ORACLE_HOME 305

<env>.env.ADOP_LOG_PATTERN 305

<ENV>.env.APPLFENV 305

<ENV>.env.APPLREP 305

<ENV>.env.APPLTMP 305

<ENV>.env.APPL_TOP 305

<ENV>.env.<BaseDirCode> 305

<ENV>.env.CONTEXT_FILE 306

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

<ENV>.env.CUSTOM_OAF_DIR 306

<env>.env.CUSTOM_PRODUCTS 306

<ENV>.env.JAVA_TOP 306

<ENV>.env.NLS_LANG 306

<ENV>.env.ORACLE_HOME 306

<ENV>.env.<parameter> 306

<ENV>.env.PLSQL_ERROR_EXPRESSION 307

<ENV>.env.<ProductCode> 307

<ENV>.env.set_escape_processing 307

<ENV>.env.SHARED_PRODUCTS 307

<env>.env.ssh_disabled 307

<ENV>.env.SQLPLUS_PREPROCESSORS 307

<ENV>.env.USE_DATABASE_CHARACTERSET 307

<ENV>.env.TWO_TASK 308

<ENV>.env.XMLIMPORTER_OPTIONAL_PARMS 308

<ENV>.env.XMLEXPORTER_OPTIONAL_PARMS 308

<ENV>.event_processors 308

<ENV>.event_timeout 308

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

<ENV>.maintmode_script 308

<ENV>.maintmode_timeout 309

<ENV>.migration_order_timeout 309

<ENV>.servername 309

<ENV>.sqlplus_options 309

<ENV>.shutdown_services_timeout 309

<ENV>._skip_object_generation 309

<ENV>.skip_show_errors 310

<ENV>._sqlplus_timeout 310

<ENV>.WFLOAD.upload_mode 310

stat.central_agent.disconnect_action 310

stat.central_agent.name_port 310

stat.central_agent.server 310

stat.db.name 310

stat.db.jdbc_driver 310

stat.central_agent.protocol 311

STAT_HOME>/conf/log4j2.xml 311

<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 Application Server

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

<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


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

<ENV>.migration_order_timeout

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.

<ENV>.servername

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

<ENV>.sqlplus_options

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

<ENV>.shutdown_services_timeout

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.

<ENV>._skip_object_generation

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

•

RDF - Report Files

•

FMB - Form Files

•

PLL - Form File Libraries

•

PKH - (PL/SQL Spec) File

•

PKB - (PL/SQL Body) File

•

PLS - PL/SQL File

•

SQLS - SQL Scripts

•

MMB - Menu File

<ENV>.skip_show_errors

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

<ENV>._sqlplus_timeout

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.

<ENV>.WFLOAD.upload_mode

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.

stat.central_agent.disconnect_action

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.

stat.central_agent.name_port

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.

stat.central_agent.server

Server or IP hosting the Stat Central Agent server.

stat.db.name

(optional parameter)

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

stat.db.jdbc_driver

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

stat.db.password

(optional parameter)

Stat Repository database password.


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

stat.db.port

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

stat.db.server

(optional parameter)

Stat Repository server name.


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

stat.db.username

(optional parameter)

Stat Repository database username.


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

stat.central_agent.protocol

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

STAT_HOME>/conf/log4j2.xml

The section explains how to configure the log4j2.xml


	NOTE: Rename log4j2.xml to the name of the instance/environment. For example, if the name of the instance/environment is VISDB-PROD then re-name the log4j2.xml as VISDB-PROD.xml

The customers running in the multiple environment scenarios, must duplicate the log4j2.xml file as many copies as the #n of the instances. For example, you must perform the above steps for each instance resulting in the structure below:

After making the required changes, re-start the Oracle Agents.

The following sections describe how to configure the log4j2 properties.

It is a mandatory property. Please provide the directory path where the log file will be created.

Here is an example to understand the configurable values. The values to be configured are highlighted.

<?xml version="1.0" encoding="UTF-8"?>

<Property name="log-path">/home/applmgr/log4jupgrade/log</Property>

<appender-ref ref="RollingFile" level="DEBUG"/>

</Logger>

</Loggers>

</Configuration>

Replace Demo.log with name of log file in above line. The name of the file where log information is written.

<appender-ref ref="RollingFile" level="INFO"/>

</Logger>

Update log level in place of INFO. 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 indegree 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.) should be used only during the initial deployment and troubleshooting to minimize the performance impact.

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

The TimeBasedTriggeringPolicy causes a rollover once the date/time pattern no longer applies to the active file. This policy accepts an interval attribute which indicates how frequently the rollover should occur based on the time pattern and a modulate boolean attribute.

Example values: Value of interval depends on date pattern. With a date pattern having hours as the most specific item, an increment of four rollovers would occur every four hours if interval value is set to 4. The default value is 1.

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

The size can be specified in bytes, with the suffix KB, MB or GB, for example 20MB. The size may also contain a fractional value such as 1.5 MB.