System configuration parameters are stored and managed by Autoconfig.
Autoconfig is a tool that simplifies and standardizes configuration management tasks in an Oracle Applications Environment.
Before the Applications context and AutoConfig were introduced, configuration management tasks could be time-consuming and prone to error, in some cases requiring manual changes to be made to several configuration files. While individual configuration files are still used in an AutoConfig-enabled environment, they play a secondary role to an XML-based repository of Applications environment information, called the context file.
By centralizing the configuration information, AutoConfig simplifies procedures for activities that range from upgrading a technology stack component to starting and stopping Applications services. Another benefit is that the various files AutoConfig employs can be updated via standard Applications patches.
There are separate context files for the application and database tiers of an Applications system.
Applications Context File :
The Applications context file, APPL_TOP/admin/<CONTEXT_NAME>.xml, is a repository for environment-specific details used by AutoConfig to configure the application tier. Information from this file is used to generate Applications configuration files and update relevant database profiles.
Information stored includes:
• Name and location of the database
• Port numbers for Forms and Web servers
• Product-specific port numbers
• Information about application tier services controlled by AutoConfig
The values of the context variables that make up the context file are in part determined by the choices you make when you run Rapid Install.
Database Context File :
The database context file, <RDBMS_ORACLE_HOME>/appsutil/<CONTEXT_NAME>.xml, performs an equivalent role on the database tier. Information from this file is used to generate configuration files used on the database tier when AutoConfig is next run.
AutoCong Scripts :
Key AutoConfig configuration scripts (command files on Windows) include:
• adautocfg.sh – Wrapper script that passes the name of the specific environment context file to adconfig.sh.
• adconfig.sh – Invoked by adautocfg.sh, this script is a wrapper for adconfig.pl.
• adconfig.pl – Invoked by adconfig.sh, this Perl script calls the Java API to carry out the actual configuration tasks. The relevant Java code is located in the
<JAVA_TOP> directory, either <COMMON_TOP>/java (on the application tier) or
RDBMS_ORACLE_HOME/appsutil/java (on the database tier).
AutoConfig Directories :
Directory Name Directory Contents
<COMMON_TOP>/admin/install/<CONTEXT_NAME> Install scripts
<COMMON_TOP>/admin/scripts/<CONTEXT_NAME> Control scripts
<COMMON_TOP>/admin/log/<CONTEXT_NAME> Log files
AutoCong Operation :
As AutoConfig is used for a wide range of system configuration activities, from installation to maintenance, the following discussion of its operations is divided into several sections.
1. Context Value Management
Context Value Management (CVM) is an AutoConfig component that is used to manage the values of variables in the context file, and automate required updates to it. CVM supports updates to both the application tier and database tier context files.
CVM actions include:
• Adding new variables to a context file.
• Updating values of variables in an existing context file.
• Applying new versions of context file templates.
• Executing scripts or configuration tools that must complete before the AutoConfig engine starts, for example when generating the tnsnames.ora file. CVM is activated when the Applications context file is updated, but before the AutoConfig engine itself starts. This enables CVM to execute scripts or other tools to manipulate any required file on the file system, and allow the appropriate settings to be propagated as needed to both the file system and database. For example, it is possible toupdate values in the context file which will then be propagated to the file system.
Like the core AutoConfig components, CVM utilizes configuration files on both the
application and database tiers,
$AD_TOP/bin/adcvm.sh Main CVM script
$AD_TOP/admin/template/adcvmat.xml Stores CVM-related data for the database tier
<RDBMS_ORACLE_HOME>/appsutil/bin/adcvm.sh Main CVM script
<RDBMS_ORACLE_HOME>appsutil/template/adcvmdb.xml Stores CVM-related data for the database tier
AutoCong Files
1. Template Files
AutoConfig template files are used as the starting point for creating site-specific configuration files.
AutoConfig evaluates the context variables in a template file, determines the actual values required, and
creates a configuration file with these values substituted. There is one template file for each configuration
file. Template files are located in the various <PROD>_TOP/admin/template directories on the application
tier, and in the <RDBMS_ORACLE_HOME>/appsutil/template directory on thedatabase tier.
Template files used by AutoConfig can be divided into the following categories:
Templates for APPL_TOP Configuration Files – These are either files requiring configuration-
specific information in the APPL_TOP, or files used to load configuration profiles into the Applications database.
Templates for Management Scripts – To run all the standard processes required by Applications,
Rapid Install creates scripts to start and stop each of these required processes. These scripts need configuration information in order to:
• Create the correct environments for each process
• Start the processes with the correct parameters
• Point the processes at the correct database instance (if applicable)
Driver Files
AutoConfig driver files are used to list the corresponding template files and locations, and specify the
commands to be executed. For example, the commands might update profile options. Driver files are
located in each <PROD>_TOP/admin/driver directory on the application tier, and in the
<RDBMS_ORACLE_HOME>/appsutil/template directory on thedatabase tier.
Configuration Files
AutoConfig configuration files, such as httpd.conf, are created as a result of AutoConfig instantiating the
corresponding template files. Configuration files contain values corresponding to the settings specified for
a particular site. After AutoConfig has been run, numerous configuration files will have been created in
various directories.
1.) Instantiation
As mentioned earlier, instantiation is the process whereby AutoConfig creates a configuration file with
contents tailored for a specific environment. AutoConfig can be used to instantiate files or scripts, and
then execute them for installation and configuration.
Examples of instantiation include:
• Instantiation of a configuration file to be used at runtime
• Instantiation of an SQL script to set profile options
• Instantiation of a shell script or Windows command file to run an SQL script in SQL*Plus
• Instantiation of scripts to start up and shut down application tier services
The adautocfg.sh script updates configuration files and profile options in the following way:
1. Instantiates template files with instance-specific values derived from the relevantcontext file
2. Copies in any customizations
3. Overwrites existing configuration files with newly instantiated ones
4. Runs SQL scripts to update database profile options.
2.) Role of the template and driver files
AutoConfig uses the various template files to determine the basic settings needed. There is one template
file for each configuration file. Different versions of the template files exist for UNIX and Windows.
The driver files list the names and locations of the files that need to have contextvariables replaced. They
also define the phases into which instantiation is divided, and specify the commands that are to be
executed for specific products. When AutoConfig runs, it cycles through the various
<PROD>_TOP/admin/driver directories looking for driver files such as adtmpl.drv, fndtmpl.drv, and
icxtmpl.drv.
Execution of Scripts
As well as its instantiation activities, AutoConfig carries out numerous other essential configuration
management tasks, by executing scripts such as the following.
Script Action
adgendbc.sh Generates the dbc file
adgenjky.sh Generates JInitiator security information
adcpnode.sh Registers nodes in the database
ssodatan.sh Associates Portal with Oracle Single Sign-On
These and other scripts are executed as applicable, depending on the requirements of the specific
Applications system.
Phases of Operation
As AutoConfig parses the driver files, it carries out a series of actions, grouped into several distinct
phases:
• INSTE8 – Instantiates AutoConfig template files to the AutoConfig configuration files specified in the
relevant template driver files.
• INSTE8_SETUP – Executes setup scripts that carry out activities not involving connection to the
database.
• INSTE8_PRF – Executes setup scripts that update profile options.
• INSTE8_APPLY – Executes setup scripts that carry out activities involving updates to the database.
• BINCPY – Copies the file mentioned from the source file to the configuration file, creating parent
directories for the latter if necessary. AutoConfig will report an error if the source file cannot be found.
• BINCPY_IGERR – Copies the file mentioned from the source file to the configuration file, creating
parent directories for the latter if necessary. AutoConfig will not report an error if the source file cannot be
found.
AutoConfig carries out these actions in the following order:
- All INSTE8 and BINCPY actions – Carries out all file instantiations called for during INSTE8,
INSTE8_SETUP, INSTE8_PRF and INSTE8_APPLY, and all copying from source files to target configuration files.
2. INSTE8_SETUP actions – For the files that were instantiated in Step 1, AutoConfig runs all SETUP
scripts.
3. INSTE8_PRF actions – For the files that were instantiated in Step 1, AutoConfig runs all PRF scripts.
4. INSTE8_APPLY actions – For the files that were instantiated in Step 1, AutoConfig runs all APPLY
scripts. At the end of this process, the required configuration files and profile options have been created
for the E-Business Suite installation.
Management Tasks
Managing the Context :
Oracle Applications Manager enables you to edit the Applications context as required. From the
Administration tab, choose AutoConfig and click Edit Parameters for the relevant context file. After
making a change to the context, you must run AutoConfig to update the relevant configuration files.
Before doing so, you should examine the proposed changes by running the adchkcfg.sh configuration
check script may on occasion be necessary to undo configuration changes. You can restore the previous
configuration by running the restore.sh utility, which enables you to roll back the changes made by an
AutoConfig run. This is achieved by utilizing the backup copies of the configuration files that are created
when AutoConfig is run.
Note: The backup files are located in
<APPL_TOP>/admin/<CONTEXT_NAME>/out/MMDDhhmm on the application tier, and
<RDBMS_ORACLE_HOME>/appsutil/out/MMDDhhmm on the
database tier, where the directory name indicates the month, day, hour and minute of the AutoConfig run.
You can restore the configuration that existed immediately before the current one by navigating to the
appropriate backup directory and running the restore.sh script. To restore an earlier configuration, you
must use the Context File History feature of Oracle Applications Manager.
Controlling the System :
AutoConfig utilizes a number of application tier control scripts, located in
<COMMON_TOP>/admin/scripts/<CONTEXT_NAME>.
Script Name Function
adstrtal.sh Starts all application tier server processes
adstpall.sh Stops all application tier server processes
adautocfg.sh Runs AutoConfig
The corresponding directory on the database tier is
<RDBMS_ORACLE_HOME>/appsutil/scripts/<CONTEXT_NAME>, where control scripts allow the
database and database listener processes to be started and stopped, and AutoConfig to be run. Checking
the System.
Examining changes :
adchkcfg.sh is located in <AD_TOP>/bin on the application tier, and in
<RDBMS_ORACLE_HOME>/appsutil/bin on the database tier.
This utility generates a report that highlights differences between existing configuration files and the new
ones that AutoConfig will generate. The report is called cfgcheck.html. Running adchkcfg.sh is useful
both in carrying out a test run before a planned environment change is made, and when investigating
problems.
Listing enabled products :
adcfginfo.sh is located in <AD_TOP>/bin on the application tier, and in
<RDBMS_ORACLE_HOME>/appsutil/bin on the database tier. This utility reports if an Applications
system is AutoConfig-enabled (which will always be the case for 11.5.10). In addition, it can optionally
list the installed products that are maintained by AutoConfig.
oraclemakeeasy 