Using AutoConfig To Manage System Configurations With Oracle Applications 11i (Doc ID 165195.1)
Using AutoConfig To Manage System Configurations With Oracle Applications 11i (Doc ID 165195.1)
1
Copyright (c) 2023, Oracle. All rights reserved. Oracle Confidential.
Using AutoConfig to Manage System Configurations with Oracle Applications 11i (Doc ID
165195.1)
July 2010
This document provides an overview of AutoConfig, instructions for migration to AutoConfig, instructions for
configuring an Oracle Applications 11i environment using AutoConfig, and a discussion of the management of
configuration customizations. It is important that you read and follow this document in its entirety before
migrating. The most current version of this document is published in Note 165195.1 on Oracle MetaLink . An
FAQ is also available in Note 218089.1 on Oracle MetaLink .
Attention: Windows users. This document typically uses UNIX syntax when specifying directories;
please substitute the appropriate Windows syntax.
Section 1: Overview
Use AutoConfig to manage your system configurations.
Section 2: Pre-requisites
Pre-requisites for migrating to AutoConfig.
Section 3: Maintaining System Configuration
Maintain the configuration of your Oracle Applications Release 11i environment.
Section 4: Managing Configuration Customizations
Customize AutoConfig generated configurations.
Section 5: Migrating to AutoConfig
Migrate to AutoConfig for the configuration management of your Oracle Applications Release 11i
environment.
Section 6: Managing Application Processes
Use AutoConfig to manage Applications processes in your Oracle Applications Release 11i environment.
Section 7: Migrating to AutoConfig on RAC
Migrate to AutoConfig for the configuration management of your 11i RAC environment.
Section 8: Migrating to AutoConfig on the Database Tier
Migrate to AutoConfig for the configuration management of your Oracle Applications Release 11i
environment on the Database Tier.
Section 9: Migrating to AutoConfig on the Application Tier
Migrate to AutoConfig for the configuration management of your Oracle Applications Release 11i
environment on the Application Tier.
Section 10: Known Issues
Known issues with the configuration management of your Oracle Applications Release 11i environment.
Conventions
Convention Meaning
User who owns the applications file system (APPL_TOP and application tier
APPLMGR
technology stack)
User who owns the database file system (RDBMS ORACLE_HOME and database
ORACLE
files).
Logical name for your Context. Default: <SID>_<hostname>
CONTEXT_NAME
In earlier versions the default was set to <SID>
CONTEXT Full path to the Context File (either Applications Context File or Database
Context File). Default:
https://support.oracle.com/epmos/faces/DocumentDisplay?_adf.ctrl-state=jedy5kneq_102&id=165195.1 1/14
11/24/23, 12:21 AM Document 165195.1
<APPL_TOP>/admin/<CONTEXT_NAME>.xml and
<RDBMS ORACLE_HOME>/appsutil/<CONTEXT_NAME>.xml
APPSuser Applications database user
Monospace Text Represents command line text. Type this command exactly as shown.
Text enclosed in angle brackets represents a variable. Substitute a value for the
<>
variable text. Do not type the angle brackets.
Section 1: Overview
AutoConfig is a tool that supports automated configuration of an Applications instance. All of the information
required for configuring an Applications instance is collected into two local repositories, called the Applications
Context and the Database Context. When AutoConfig runs on the Application tier, it uses information from the
Applications Context file to generate all configuration files and update database profiles. When AutoConfig runs
on the Database tier, it uses information from the Database Context file to generate all configuration files used
on the Database tier.
Configuration Support: AutoConfig configures the APPL_TOP, the ORACLE_HOME(s) and its supporting
technology stack.
Configuration Management: AutoConfig centralizes the configuration and re-configuration of an
Applications instance.
Configuration Delivery and Patching: The uptake of new technology is simplified, as new configurations
and configuration changes can be provided in the form of a patch.
Component Description
Applications Context An XML repository located in the APPL_TOP containing information specific to
that APPL_TOP.
Database Context An XML repository located in the RDBMS ORACLE_HOME containing information
specific to that Database tier.
AutoConfig File Templates Template files that include named tags, which are replaced with instance-
specific information from the according Context (this process is called
"instantiation").
AutoConfig Driver File Every product in the E-Business Suite maintains a driver file used by
AutoConfig. The driver file lists the AutoConfig file templates and their
destination locations.
AutoConfig Scripts A set of scripts that provide a simplified interface to the AutoConfig APIs.
Once an APPL_TOP is enabled for AutoConfig, it has an Applications Context file stored in the APPL_TOP as
<APPL_TOP>/admin/<CONTEXT_NAME>.xml. Once the Database is enabled for AutoConfig, it has a Database
Context file stored in the RDBMS ORACLE_HOME as <RDBMS ORACLE_HOME>/appsutil/<CONTEXT_NAME>.xml.
When a change is made to any of the Context files or any of the templates, the AutoConfig utility updates the
Applications 11i configuration.
AutoConfig can also start and stop all Applications system processes that it manages.
Please note that AutoConfig must be implemented on the Database Tier and all Application Tiers.
Section 2: Pre-requisites
Complete the steps in this section (in the order listed) before you migrate to AutoConfig. If you have already
migrated to AutoConfig, verify that the pre-requisites are met before applying the latest AutoConfig patch.
1. AD minipack Requirements. If you are not on AD minipack F or later, apply the latest AD minipack
from OracleMetaLink.
https://support.oracle.com/epmos/faces/DocumentDisplay?_adf.ctrl-state=jedy5kneq_102&id=165195.1 2/14
11/24/23, 12:21 AM Document 165195.1
2. Verify software versions
The following software component versions must exist on the application tier and/or on the database tier.
The tier column indicates the node where the software component must be present.
Software Minimum Tier Details
Version
Must install JRE 1.3.1_1.5 or higher into the <RDBMS
ORACLE_HOME>/jre/1.3.1 directory. This directory will
JRE 1.3.1 Database tier
be used by the AutoConfig java utility. See Appendix A
for installation instructions.
Refer to Upgrading to JDK 1.3 with Oracle
JDK 1.3.1 Application tier
Applications 11i on OracleMetaLink for instructions.
Application tier
Zip 2.3 and database Download from InfoZip. Zip must be in your PATH.
tier
TRU64
customers
ONLY - Download Perl 5.6 from Perl.com. Perl must be in the
Perl 5.6
Application tier PATH for running AutoConfig.
and database
tier
3. For Windows customers ONLY. Download and apply the Windows AutoConfig Updates:
4617175 - Provide specific Windows executables
4445697 - Provide the Windows Service Control Wrapper (OaMkSvc)
This section describes how to apply latest AutoConfig patch and manage your Oracle Applications Release 11i if
your Instance is AutoConfig enabled. In addition to re-configuring your system, AutoConfig can be used to
review changes made to the configuration files, to start and stop Applications processes and to start and stop
Database processes.
Note: Running AutoConfig might change your existing environment files. After running
AutoConfig, you should always set the environment before you run any Applications utilities
in order to apply the changed environment variables.
https://support.oracle.com/epmos/faces/DocumentDisplay?_adf.ctrl-state=jedy5kneq_102&id=165195.1 3/14
11/24/23, 12:21 AM Document 165195.1
All scripts listed below are located in
<COMMON_TOP>/admin/scripts/<CONTEXT_NAME>.
Note: Running AutoConfig might change your existing environment files. After running
AutoConfig, you should always set the environment before you run any Applications utilities
in order to apply the changed environment variables.
3. Patching AutoConfig
If you were instructed to apply the latest AutoConfig patch, perform the following steps in the order
listed:
Attention: The database server and the database listener must remain available
during the AutoConfig run. All the other database tier services should be shut down.
Attention: The database server and the database listener must remain available
during the AutoConfig run. Only the application tier servers should be shut down.
https://support.oracle.com/epmos/faces/DocumentDisplay?_adf.ctrl-state=jedy5kneq_102&id=165195.1 4/14
11/24/23, 12:21 AM Document 165195.1
Use the web based Context Editor from OAM to perform configuration updates to your
Applications Context. OAM provides advanced features for context file editing. Refer to Oracle
Applications Manager 11i Availability for instructions on installing OAM. Refer to Oracle
Applications Maintenance Procedures - Section Managing Configuration Parameters for information
on how to use the OAM Context Editor.
Note: Configuration changes will not take effect until you run AutoConfig and restart
your server processes.
Tier Directory
Application <APPL_TOP>/admin/<CONTEXT_NAME>/out/<MMDDhhmm>
Database <RDBMS ORACLE_HOME>/appsutil/out/<CONTEXT_NAME>/<MMDDhhmm>
On UNIX
restore.sh
On Windows
restore.cmd
Tier Directory
Application <APPL_TOP>/admin/<CONTEXT_NAME>/log/<MMDDhhmm>
Database <RDBMS ORACLE_HOME>/appsutil/log/<CONTEXT_NAME>/<MMDDhhmm>
There will be one log file per AutoConfig session, and it will contain exact information for every action
that AutoConfig performed.
################################################################
#
# This file is automatically generated by AutoConfig. It will be read and
# overwritten. If you were instructed to edit this file, or if you are not
# able to use the settings created by AutoConfig, refer to Metalink
# document 165195.1 for assistance.
#
################################################################
If the files maintained by AutoConfig require customization, refer to Note 270519.1 on Oracle MetaLink .
Complete the steps in this section (in the order listed) to migrate to AutoConfig. If your have already migrated
to AutoConfig, refer to Section 3 to learn about maintaining your system configuration using AutoConfig:
https://support.oracle.com/epmos/faces/DocumentDisplay?_adf.ctrl-state=jedy5kneq_102&id=165195.1 5/14
11/24/23, 12:21 AM Document 165195.1
1. Apply TXK AutoConfig and Templates patch
Update the Oracle Applications file system with the AutoConfig files by applying patch 9535311 to all
application tier nodes in the Applications instance. Apply the unified driver.
Your system is now AutoConfig enabled. Refer to Section 3 on information on maintaining system
configurations.
This section describes how to manage Applications processes through AutoConfig. As mentioned in Section 3,
the scripts adstrtal.sh/cmd and adstpall.sh/cmd can be used for starting and stopping all AutoConfig-managed
processes on the Applications system.
Depending on the requirement of a particular Applications instance, it is possible to modify the set of
Applications processes that will be started and stopped via AutoConfig. This can be done by enabling the
required processes and disabling the others.
1. To enable a process, ensure that the value of the 'status' context variable corresponding to the process is
set to 'enabled'.
2. To disable a process, ensure that the value of the 'status' context variable corresponding to the process
is set to 'disabled'.
This section guides you through the steps that need to be performed when your Oracle 11i instance is running
on RAC and you want to enable AutoConfig.
Note: If your 11i instance is running on a non-RAC database and you decide to migrate to RAC,
follow the steps described in Note 279956.1 on Oracle MetaLink .
The AutoConfig patch delivers the infrastructure to generate a complete tnsnames.ora file required for RAC.
This includes
The tnsnames.ora file is dynamically generated using the Net Services Topology Data Model. The Net Services
Topology Data Model stores the entire topological information about a single Oracle Application instance.
Complete the steps in this section (in the order listed) to migrate to AutoConfig on RAC:
2. Review init.ora
AutoConfig will not overwrite your existing init.ora file in the <ORACLE_HOME>/dbs directory. However,
AutoConfig will generate a RAC conforming init.ora file when no init.ora file exists in the
<ORACLE_HOME>/dbs directory. We recommend creating a backup of the existing init.ora file and let
https://support.oracle.com/epmos/faces/DocumentDisplay?_adf.ctrl-state=jedy5kneq_102&id=165195.1 6/14
11/24/23, 12:21 AM Document 165195.1
AutoConfig generate a new init.ora file. This will ensure that the init.ora file conforms to Oracle standards
(For example, usage of DB_Name as the service name or handling local and remote listeners).
3. Migrate to AutoConfig on the Database Tier
Follow the steps in Section 8 to migrate to AutoConfig on the Database Tier. If you have already
migrated to AutoConfig on the Database Tier, then you can omit that section.
Attention: The database server and the database listener must remain available during the
AutoConfig run. All the other database tier services should be shut down.
Attention: The database server and the database listener must remain available during the
AutoConfig run.
Your system is now AutoConfig enabled. Refer to Section 3 for information on maintaining system
configurations.
Complete the steps in this section (in the order listed) to migrate to AutoConfig on the Database Tier. If you
have already migrated to AutoConfig on the Database Tier omit this section.
https://support.oracle.com/epmos/faces/DocumentDisplay?_adf.ctrl-state=jedy5kneq_102&id=165195.1 7/14
11/24/23, 12:21 AM Document 165195.1
1. Your Applications system was created with Release 11.5.8 Rapid Install or earlier and you do not
already have a Database Context file
2. You have a new Oracle Home due to the following reasons:
You are performing a cross-platform migration of the database tier
You are upgrading the database
On Windows
Source the .cmd file using <RDBMS ORACLE_HOME>\<CONTEXT_NAME>.cmd
cd /d <RDBMS ORACLE_HOME>\appsutil\bin
perl adbldxml.pl tier=db appsuser=<APPSuser>
Attention: adbldxml uses your current environment settings to generate the context file.
Therefore ensure that your environment is correctly sourced.
Attention: If you build the context file for an 11i instance that runs on RAC, all your RAC
instances have to be up and running while executing the adbldxml utility. The utility connects
to all RAC instances to gather information about the configuration.
Note: For more detailed information on adbldxml usage please review (Doc ID 1310854.1)
How to Get the Proper Environment Set to Enable Autoconfig with adbldxml.pl When
Upgrading an EBS Database?.
3. Prepare for AutoConfig
Complete the following AutoConfig steps.
Review Prior Manual Configuration Changes
The Database Context File may not include manual post-install configuration changes made after
the Rapid Install completed. Before running the AutoConfig portion of this patch, review any
modifications to specific configuration files and reconcile them with the Database Context file.
Note: Prior modifications include any changes made to configuration files as instructed
in patch READMEs or other accompanying documents.
Attention: This step performs the conversion to AutoConfig. Once completed, the previous
configuration will not be available.
Attention: The database server and the database listener must remain available during the
AutoConfig run. All the other database tier services should be shut down.
Execute the following commands:
On UNIX
cd <RDBMS ORACLE_HOME>/appsutil/bin
adconfig.sh contextfile=<CONTEXT>
On Windows
cd /d <RDBMS ORACLE_HOME>\appsutil\bin
adconfig.cmd contextfile=<CONTEXT>
Warning: Running AutoConfig on the database node will update the RDBMS network listener
file. Be sure to review the configuration changes from step 3. The new AutoConfig network
listener file supports the use of IFILE to allow for values to be customized or added as
needed.
https://support.oracle.com/epmos/faces/DocumentDisplay?_adf.ctrl-state=jedy5kneq_102&id=165195.1 8/14
11/24/23, 12:21 AM Document 165195.1
Note: Running AutoConfig on the database tier will NOT overwrite any existing init.ora file in
the <ORACLE_HOME>/dbs directory. If no init.ora file exists in your instance, AutoConfig will
generate an init.ora file in the <ORACLE_HOME>/dbs directory for you.
On Windows platform, during each AutoConfig run the init.ora file in <ORACLE_HOME>/dbs
directory is copied over to <ORACLE_HOME>/database directory.
Note: Running AutoConfig might change your existing environment files. After running
AutoConfig, you should always set the environment before you run any Applications utilities
in order to apply the changed environment variables.
Complete the steps in this section (in the order listed) to migrate to AutoConfig on the Application Tier. If you
have already migrated to AutoConfig on the Application Tier omit this section.
If this file does not exist, then set your environment and execute the following command to create your
Applications Context File:
On UNIX
cd <AD_TOP>/bin
perl adbldxml.pl tier=apps appsuser=<APPSuser>
On Windows
cd /d <AD_TOP>\bin
perl adbldxml.pl tier=apps appsuser=<APPSuser>
Attention: adbldxml uses your current environment settings to generate the context file.
Therefore ensure that your environment is correctly sourced.
Attention: If you build the context file for an 11i instance that runs on RAC, all your RAC
instances have to be up and running while executing the adbldxml utility. The utility connects
to all RAC instances to gather information about the configuration.
On Windows:
cd <IAS_ORACLE_HOME>\Apache\Apache
apache.exe -V
If you have iAS 1.0.2.2.2, you must patch the Oracle HTTP Sever (OHS) component. Apply OHS
patch 2674529.
You must update the oprocmgr_port value in the Applications Context file with a free port number.
https://support.oracle.com/epmos/faces/DocumentDisplay?_adf.ctrl-state=jedy5kneq_102&id=165195.1 9/14
11/24/23, 12:21 AM Document 165195.1
Review the <IAS_HOME>/Apache/Apache/conf/httpd.conf file, under the <IfModule
mod_oprocmgr.c> section, and use the port already chosen there. Refer to Section 8 for more
information on how to edit your configuration.
Review Prior Manual Configuration Changes
The Applications Context File may not include manual post-install configuration changes made
after the Rapid Install completed. Before running the AutoConfig portion of this patch, review any
modifications to specific configuration files and reconcile them with the Applications Context file.
Attention: The database server and the database listener must remain available during the
AutoConfig run. Only the application tier servers should be shut down.
Attention: This step performs the conversion to AutoConfig. Once completed, the previous
configuration will not be available.
Note: Running AutoConfig might change your existing environment files. After running
AutoConfig, you should always set the environment before you run any Applications utilities
in order to apply the changed environment variables.
This section contains known issues with the configuration management of your Oracle Applications Release 11i
environment.
1. Download JRE 1.3.1_15 or higher from Oracle (Sun Microsystems) Java. Refer to JDK upgrade guide for
the download location for other platforms.
2. Follow the installation instructions.
3. When prompted for the location to install jre, click browse and enter the location:
<RDBMS ORACLE_HOME>\jre\1.3.1_<version number> where version number is 15 or higher.
4. Accept the default plug-in options.
https://support.oracle.com/epmos/faces/DocumentDisplay?_adf.ctrl-state=jedy5kneq_102&id=165195.1 10/14
11/24/23, 12:21 AM Document 165195.1
1. The Check Config utility (adchkcfg) is located at:
Tier Command
Application <AD_TOP>/bin
Database <RDBMS ORACLE_HOME>/appsutil/bin
On UNIX
adchkcfg.sh contextfile=<CONTEXT>
On Windows
adchkcfg.cmd contextfile=<CONTEXT>
This script will generate both html and text reports that provide information about all file changes, profile
option changes and other important database updates that will be done during the next normal
execution of AutoConfig. The report consists of two tabs:
Database Changes
This report provides information about all the profile options that get changed during the next
normal execution of AutoConfig. This report is divided into three sections.
Profile Value Changes
Displays the details only for profiles whose value would be changed in the next AutoConfig
run. For each such profile, the current value in the Database, the new AutoConfig value
that would be set for it, the Profile Level and the name of the AutoConfig script that
changes the profile value is displayed.
Profile Values
Displays the details as in previous section for all Apps Database profiles managed by
AutoConfig.
Other Database updates
Displays the details for important database updates that will be done in the next run of
AutoConfig. The table name, column name, the current column value in the Database and
the new AutoConfig value is displayed along with the name of the updating AutoConfig
script and a brief description.
Resolve any reported differences between your existing files and the files AutoConfig will create.
The script will also create a zip file report "ADXcfgcheck.zip" that contains all the files and reports
mentioned above, so that the ADXcfgcheck.zip can be copied to a local desktop PC and the html report
can be viewed there without breaking the hyper-links in the report.
https://support.oracle.com/epmos/faces/DocumentDisplay?_adf.ctrl-state=jedy5kneq_102&id=165195.1 11/14
11/24/23, 12:21 AM Document 165195.1
PERL5LIB=<IAS_ORACLE_HOME>/Apache/perl/lib/5.00503:
<IAS_ORACLE_HOME>/Apache/perl/lib/site_perl/5.005:<AU_TOP>/perl
export PERL5LIB
PERL5LIB=<ORACLE_HOME>/Apache/perl/lib/5.00503:
<ORACLE_HOME>/Apache/perl/lib/site_perl/5.005:<ORACLE_HOME>/appsutil/perl
export PERL5LIB
On an 11i Instance with 10g Database, the Database tier does not have the 'Apache' directory. The perl libraries
are present in the directory '$ORACLE_HOME/perl/lib'. So the variable 'PERL5LIB' on the 10g Database tier
needs to be set as follows:
<ORACLE_HOME>/perl/lib/5.8.3:<ORACLE_HOME>/perl/lib/site_perl/5.8.3:
<ORACLE_HOME>/appsutil/perl
export PERL5LIB
On an 11i instance with 11gR2 Database, the perl version on the database tier is '5.10.0'. So the variable
'PERL5LIB' on the 11gR2 database tier needs to be set as follows:
<ORACLE_HOME>/perl/lib/5.10.0:<ORACLE_HOME>/perl/lib/site_perl/5.10.0:
<ORACLE_HOME>/appsutil/perl
export PERL5LIB
The AutoConfig Performance Profiler is a new feature introduced in TXK AutoConfig and Templates Rollup patch
S 6372396.
This new feature can be used to profile an AutoConfig run and generate a consolidated report in HTML format.
The profile report is comprised of the following sections:
The product tops listed in the summary section can be drilled down to view the profile information for individual
templates.
Details
This section contains the profile information for all product templates that are only instantiated or
instantiated and executed in the current AutoConfig run. It shows the following:
Script Name: Target name of the template.
Instantiation Time: Time taken to instantiate the template.
https://support.oracle.com/epmos/faces/DocumentDisplay?_adf.ctrl-state=jedy5kneq_102&id=165195.1 12/14
11/24/23, 12:21 AM Document 165195.1
Execution Time: Time taken to execute the instantiated template.
Time (%): Percentage of product top processing time taken to process the template.
Status: Whether or not the template was successfully processed.
Execution Summary: Contains the source and target locations of the template and the execution
report of the script. This summary can be viewed by clicking on the script name link in the
detailed report.
AutoConfig can be run in profile mode using the '-profile' command line option. For example:
The TXK Context Variable Information utility was introduced in TXK AutoConfig and Templates Rollup patch S
(6372396).
This command-line utility can be used to find out detailed information about context variables and the templates
that use them. The utility accepts all or part of a context variable name and generates an html or text report
containing information about all of the matched context variables, including variable descriptions, default and
current values. The variable description contains recommended settings, range of allowed values and links to
documents for detailed usage information. Additionally, this utility lists the configuration templates where
specific context variables are used. See a snapshot of the generated report.
1. Source the Applications environment file as the owner of the application tier file system (APPLMGR user).
On UNIX:
txkrun.pl -script=GenCtxinfRep [arg1 arg2 ..]
On Windows:
%ADPERLPRG% %FND_TOP%\bin\txkrun.pl -script=GenCtxinfRep [arg1 arg2 ..]
For example:
REFERENCES
https://support.oracle.com/epmos/faces/DocumentDisplay?_adf.ctrl-state=jedy5kneq_102&id=165195.1 13/14
11/24/23, 12:21 AM Document 165195.1
https://support.oracle.com/epmos/faces/DocumentDisplay?_adf.ctrl-state=jedy5kneq_102&id=165195.1 14/14