Details

Conventions

Attention: Windows users - this document typically uses UNIX syntax when specifying directories. Substitute the appropriate Windows syntax where applicable.

Section 1: Overview of AutoConfig Components and Tools

AutoConfig is a tool that supports automated configuration of an Oracle E-Business Suite Release 12 instance. All the information required for configuring an Applications instance is collected into two local repositories, called the Applications context file and the database context file. 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.

AutoConfig provides several major benefits, including:

Configuration Support: AutoConfig configures the APPL_TOP, the ORACLE_HOMEs, and the 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.

1.1. AutoConfig Components

AutoConfig consists of several components:

The Applications Release 12 application tier is AutoConfig-enabled, and has an Applications context file stored in the INST_TOP as <INST_TOP>/appl/admin/<CONTEXT_NAME>.xml. The Applications Release 12 database tier created via Rapid Install is also AutoConfig-enabled, and 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 template files, the AutoConfig utility updates the Applications Release 12 configuration.

AutoConfig can also be used to start and stop all Applications system services that it manages.

1.2. AutoConfig Tools

Below is a summary of the AutoConfig tools.

Besides the above tools, there are start and stop tools that are used to manage the run-time processes of EBS Services. These tools are listed in Section 7.

Section 2: Using AutoConfig Tools for System Configuration

As mentioned in Section 1, AutoConfig is used to automate system configuration. This section describes how the AutoConfig tools can be used for this purpose. These tools are meant to be used in the following order:

2.1. Previewing Effects of Running AutoConfig

Before running AutoConfig, the Check Config utility may be run to review the changes that would occur in the file system as well as the database in the next AutoConfig run. This step is optional.

Execute the following command to run the Check Config utility.

On the Database tier:
- On Unix:
- On Windows:

sh <RDBMS_ORACLE_HOME>/appsutil/bin/adchkcfg.sh contextfile=<CONTEXT_FILE>
<RDBMS_ORACLE_HOME>\appsutil\bin\adchkcfg.cmd contextfile=<CONTEXT_FILE>

On the Applications tier:

On Unix:
On Windows:

sh <AD_TOP>/bin/adchkcfg.sh contextfile=<CONTEXT_FILE>
<AD_TOP>\bin\adchkcfg.cmd contextfile=<CONTEXT_FILE>

Please refer to Section 5.3 for more details on this tool.

2.2. Run AutoConfig on the Database Tier

Running AutoConfig on the database tier is required in the following scenarios:

After migrating a patch to the database tier, the Check Config utility reports any potential changes to the templates.
After customizations on the database tier
After a database or application tier upgrade
After restoration of the database or Oracle Home from a backup tape
After a JDK upgrade on the database tier
After the Net Services Topology Information is manually cleaned up using one of the supported procedures(eg. fnd_conc_clone.setup_clean). Subsequently, AutoConfig must be run on the application tier nodes.
After registration of a RAC node.
After setting up the APPL_TOP on a shared file system.
All other cases where documentation says that AutoConfig should be run on the database tier.

Execute the following command to run AutoConfig on the database tier.

On Unix:
On Windows:

sh <RDBMS_ORACLE_HOME>/appsutil/scripts/<CONTEXT_NAME>/adautocfg.sh
<RDBMS_ORACLE_HOME>\appsutil\scripts\<CONTEXT_NAME>\adautocfg.cmd

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.
Running AutoConfig may 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.

2.3. Run AutoConfig on the Application Tier

Run AutoConfig on all application tier nodes.

Execute the following command to run AutoConfig.

On Unix:
On Windows:

sh <INST_TOP>/admin/scripts/adautocfg.sh
<INST_TOP>\admin\scripts\adautocfg.cmd

Attention:

The database server and the database listener must remain available during the AutoConfig run. Only the application tier servers should be shut down.
Running AutoConfig may 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.

2.4. Reviewing AutoConfig Log Files

AutoConfig logfiles are stored under:

Tier

Application

Database

Directory

$INST_TOP/admin/log/MMDDYYYY/adconfig.log

<RDBMS ORACLE_HOME>/appsutil/log/<CONTEXT_NAME>/<MMDDhhmm>

One log file is created per AutoConfig session. It will contain details of every action that AutoConfig performed during the run.

2.5. Rolling Back an AutoConfig Session

Each AutoConfig run of creates a rollback script you can use to revert to the previous configuration settings if necessary. The script and all backup configuration files from each AutoConfig session are stored in:

Tier

Application

Database

Directory

<INST_TOP>/admin/out/<MMDDhhmm>

<RDBMS ORACLE_HOME>/appsutil/out/<CONTEXT_NAME>/<MMDDhhmm>

where:<MMDDhhmm> = (month, day, hour, minute of AutoConfig run)

To roll back an AutoConfig session, execute the following commands:

On UNIX
On Windows

$APPL_TOP/admin/$CONTEXT_NAME/out/<MMDDYYYY>/restore.sh
restore.cmd

Section 3: Patching AutoConfig

For patching AutoConfig on the E-Business Suite R12 instance, AutoConfig needs to be enabled on both the applications tier and the database tier.

3.1. Applying the Latest AutoConfig Updates

In order to get the latest AutoConfig updates on both the applications tier and the database tier, perform the following steps in the order listed:

Apply the TXK AutoConfig Template patch
Update the Oracle Applications file system with the AutoConfig files by applying the latest AutoConfig Template patch (Patch 9386653 for 12.0.X customers and Patch 8919489 for 12.1.X customers) to all application tier nodes in the Applications instance.
1. Windows Itanium customers on 12.0.X should apply an additional one-off patch, 6501658. Customers need to be on at least the 12.0.2 patchset in order to apply this one-off patch.

Note: ADX and TXK rollup patches for configuration management have been combined.

Copy AutoConfig to the RDBMS ORACLE_HOME
1. Update the RDBMS ORACLE_HOME file system with the AutoConfig files by performing the following steps:
  - On the application tier (as the APPLMGR user):
On the database tier (as the ORACLE user):
- Copy or FTP the appsutil.zip file to the <RDBMS ORACLE_HOME>

perl <AD_TOP>/bin/admkappsutil.pl

cd <RDBMS ORACLE_HOME>
unzip -o appsutil.zip

Run AutoConfig
1. Run AutoConfig on the database tier and then on the applications tier as described in sub-sections 2.2 and 2.3 in Section 2.

3.2. Enabling AutoConfig on a New Oracle Home

In R12, AutoConfig is enabled by default on the applications tier. But it might not be enabled on the database tier in the following scenarios:

Database tier not created by Rapid Install
Cross platform migration of the database tier
Upgrading to 11g Database
Upgrading the database tier from Applications 11i to E-Business Suite Release 12

In order to enable AutoConfig on the database tier, perform the following steps in the order listed:

Apply patch 6636108 on the Applications tier
Customers who are on 12.0.X need to apply this patch which delivers the adbldxml utility for generating the context file on the database tier. This patch is also included in the latest AutoConfig Template patch (Patch 9386653 for 12.0.X customers and Patch 8919489 for 12.1.X customers).
Copy AutoConfig to the RDBMS ORACLE_HOME
1. Update the RDBMS ORACLE_HOME file system with the new AutoConfig files delivered in the above patch following Step 2 in Section 3.1.
Install JRE on the Database tier
Follow the steps below to ensure that jre version on the applications tier and the database tier is atleast 1.5 or higher:
Generate the Database Context File
Execute the following command to create your Database Context File:
Run AutoConfig on the Database tier
Run AutoConfig on the Database tier by executing the below command:

perl <RDBMS_ORACLE_HOME>/appsutil/bin/adbldxml.pl

<RDBMS_ORACLE_HOME>/appsutil/bin/adconfig.sh contextfile=<context_file>
<RDBMS_ORACLE_HOME>\appsutil\bin\adconfig.cmd contextfile=<context_file>

Section 4: Customizing AutoConfig-Managed Configurations

AutoConfig is a tool that simplifies and standardizes configuration management tasks in an Oracle E-Business Suite environment. The configuration generated by AutoConfig may not always meet your specific requirements, and it may be necessary to customize AutoConfig for your environment.

Examples where you might want to customize AutoConfig include:

Start additional services or processes when you start Oracle Applications services
Define your OC4J configuration
Extend Oracle Forms to integrate with a third party Java version
Develop custom applications that are maintained by AutoConfig

Historically, Oracle did not document procedures on how to implement customizations. If you tried to customize your AutoConfig-generated files by manually editing them, your changes were lost every time AutoConfig ran. To avoid this, Oracle Support may have instructed you to add your customizations between "Begin/End customizations" blocks in the configuration files. This limited and inflexible method has now been superseded by a fully supported mechanism to extend your AutoConfig-maintained environment with maximum flexibility, and preserving your extensions every time AutoConfig is run.

4.1. Prerequisites for AutoConfig Customizations

Before customizing AutoConfig, certain prerequisites must be met.

Review your current configuration
1. Run the AutoConfig check utility as described in Section 5.3. Review any differences in the report and identify the manual configuration changes that you want to implement as customizations.
Review and migrate existing customizations
1. If you implemented customizations between "Begin/End customization" blocks in the past, then you must migrate those settings now. Execute the following command:

The adcustomizer script:
Detects all configuration files that have "Begin/End customizations" blocks.
Copies the corresponding AutoConfig template files to custom template files.
Appends the contents in the "Begin/End customizations" blocks to the end of the custom template files.
Removes the "Begin/End customizations" blocks from the configuration file.

Review the logfile generated by the adcustomizer script. Ensure that all your customizations were successfully migrated to the custom template file(s) by examining the generated custom template file(s).

4.2. Implementing AutoConfig Customizations

This section addresses the different types of customizations and how to implement them.

Note: All files managed by AutoConfig have the following header:

################################################################

# 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 387859.1 for assistance.

################################################################

After identifying your customization need, perform the steps associated with it. Oracle supports the following types of customizations:

Changing the value of an existing context variable
1. Edit the context variable value
  1. Use the Oracle Applications Manager Context Editor to change values of existing context variables. Refer to Oracle Applications System Administrator's Guide - Configuration for details of how to use the Oracle Applications Manager Context Editor.
2. Run AutoConfig
  1. Depending on whether the context variable belongs to the application tier or the database tier, run AutoConfig on the appropriate tier, following the steps mentioned in Section 2.

��

Adding a new context variable to the context file

Add the context variable
1. Use the Oracle Applications Manager Context Editor if you want to add a context variable that is not maintained by AutoConfig. Refer to the Help pages available on Oracle Applications Manager. The relevant information for adding custom context variables is located in the "System Configuration" > "AutoConfig" > "Manage Custom Parameters" section.
Run AutoConfig
1. Depending on whether the context variable has been added for the application tier or the database tier, run AutoConfig on the appropriate tier, following the steps mentioned in Section 2.

��

Customizing an AutoConfig template file delivered by Oracle

If you want to customize an existing AutoConfig template file, perform the following steps in the order listed:

Determine the AutoConfig template file you want to customize
Execute the following command to find out the corresponding AutoConfig template file for the configuration file you want to customize:
1. - For example, if you want to customize
  - $INST_TOP/admin/install/afwebprf.sh
- On UNIX

$AD_TOP/bin/adtmplreport.sh contextfile=$CONTEXT_FILE \
target=$INST_TOP/admin/install/afwebprf.sh
%AD_TOP%\bin\adtmplreport.cmd contextfile=%CONTEXT_FILE% \
target=%INST_TOP%\admin\install\afwebprf.cmd

On Windows

The adtmplreport utility returns the name and location of the AutoConfig template file. For the above UNIX example it would return:
$FND_TOP/admin/template/afwebprf.sh
You cannot customize all AutoConfig template files. The AutoConfig template file cannot be customized if the "LOCK" keyword appears in the template file's entry in the product driver file. AutoConfig ignores custom template files that are marked with "LOCK".
For example, the following entry in <AD_TOP>/admin/driver/adtmpl.drv would prevent customization of the file adconfig.txt:

Create the custom template directory
1. Create a directory named "custom" at the location where the AutoConfig template file resides.

For example, if you want to customize <FND_TOP>/admin/template/afwebprf.sh, execute the following command as the applmgr user:
- On UNIX
- On Windows

Copy the AutoConfig template file
- Copy the AutoConfig template file to the custom template file.
- Execute the following command as the applmgr user:
- On UNIX

ad admin/template adconfig.txt INSTE8 <s_at>/admin adconfig.txt 600 LOCK

mkdir $FND_TOP/admin/template/custom
mkdir %FND_TOP%\admin\template\custom

cp -i <AutoConfig template file> <custom template file>
- cp -i $FND_TOP/admin/template/afwebprf.sh \
- $FND_TOP/admin/template/custom/afwebprf.sh
copy <AutoConfig template file> <custom template file>
- copy %FND_TOP%\admin\template\afwebprf.cmd \
- %FND_TOP%\admin\template\custom\afwebprf.cmd

For example:

On Windows

For example:

Edit the custom template file

Edit the custom template file with the text editor of your choice, such as vi on UNIX or Wordpad on Windows.

Note: It is not supported to edit AutoConfig template files. Be sure to edit the custom template file.

Verify your customizations
1. Execute the adchkcfg utility as described in Section 5.3. When this utility runs, it instantiates any custom template files in place of the corresponding AutoConfig template file. The adchkcfg utility generates a report with information about all files and profile options that will be changed during the next normal run of AutoConfig. Verify that your customizations would be applied as expected in your next AutoConfig run.

Note: adchkcfg.sh/cmd instantiates the templates into the following location:
On the application tier:
<INST_TOP>/admin/out/<MMDDhhmm>
On the database tier:
<RDBMS ORACLE_HOME>/appsutil/out/<CONTEXT_NAME>/<MMDDhhmm>

Run AutoConfig
1. Run AutoConfig as described in Section 2. When AutoConfig runs, it instantiates any custom template file in place of the corresponding AutoConfig template file.

Creating a customer-owned AutoConfig template file

OA_VAR = c_mytop
Default Value = <s_at>/my/12.0.0
Title = My Product top
Description = This is my product top
OA_TYPE = PROD_TOP

Create the customer-owned AutoConfig template directory
1. Create the directory where your AutoConfig template files will reside. Execute the following command as the applmgr user:
  - On UNIX
  - On Windows
Develop the customer-owned AutoConfig template file
1. Create the custom AutoConfig template file in the custom product top AutoConfig template directory. There are no file name restrictions, and the new template file can be of any type that can store text, such as text file, shell script, Perl script, or SQL script. To use AutoConfig instantiation, enter your context variables in the file. When AutoConfig runs, it replaces the context variables with the associated values from the context file.
  1. For example, create and edit the file
  2. <c_mytop>/admin/template/myTemplate.txt
Create the customer-owned AutoConfig driver directory
1. Create the directory where your AutoConfig driver file will reside. Execute the following command as the applmgr user:
  - On UNIX
  - On Windows
Develop the customer-owned AutoConfig driver file
1. The AutoConfig driver file instructs AutoConfig where to place the generated configuration file. Place the driver file in the custom AutoConfig driver directory. The name for the driver file is defined as: <product>tmpl.drv. In this example, the driver file would be named: mytmpl.drv. Refer to Appendix A: Specification for AutoConfig Driver File Syntax for information on the format of the driver file.
  1. For example, to have AutoConfig instantiate the above example template file, the driver file would need to contain this line:

4.3. Advanced Features of AutoConfig Customizations

This section discusses advanced features when using AutoConfig Customizations.

Debugging customizations
1. If problems arise with customizations that you implemented, it may be useful to run AutoConfig with the AutoConfig template files, ignoring any custom template files. Execute the following command:
  - On UNIX
  - On Windows
Preserving customizations after updates
1. You must review your customizations whenever AD Patch delivers a new version of an AutoConfig template file for which you edited the corresponding custom template file. If the customizations are still required, copy the new version of the AutoConfig template file to the custom template directory, and edit the custom template file with your customizations.
  1. AutoConfig checks that your custom template files are of the same versions as the AutoConfig template files, and will not run if it detects any version mismatch.
Reports
1. The report produced by the adtmplreport utility can:
  - List all customized files in an Oracle E-Business Suite instance
  - List all AutoConfig template files, their custom template files and their configuration files
  - Identify the name and location of the AutoConfig template file and the custom template file for a given configuration file
  - Identify the name and location of the configuration file for a given AutoConfig template file
2. The report utility is located at:

my admin/template myTemplate.txt INSTE8 <s_pt> myConfiguration.txt 660

<AD_TOP>/bin/adconfig.sh -nocustom contextfile=<CONTEXT_FILE>
<AD_TOP>\bin\adconfig.cmd -nocustom contextfile=<CONTEXT_FILE>

mkdir <c_mytop>/admin/template
mkdir <c_mytop>\admin\template

mkdir <c_mytop>/admin/driver
mkdir <c_mytop>\admin\driver

Tier
Application
Database

Location
<AD_TOP>/bin
<RDBMS ORACLE_HOME>/appsutil/bin

To list all files that you customized in an Oracle E-Business Suite instance:

Platform
UNIX
Windows
Platform
UNIX
Windows

To list all configurations files, their AutoConfig template files and their custom template files:

Command
adtmplreport.sh contextfile=<CONTEXT_FILE> listcustom
adtmplreport.cmd contextfile=<CONTEXT_FILE> listcustom

Command
adtmplreport.sh contextfile=<CONTEXT_FILE>
adtmplreport.cmd contextfile=<CONTEXT_FILE>

To identify the configuration file for a given AutoConfig template file:

Platform
UNIX
Windows

Command
adtmplreport.sh contextfile=<CONTEXT_FILE> template=<templatefilepath>
adtmplreport.cmd contextfile=<CONTEXT_FILE> template=<templatefilepath>

To identify the AutoConfig template and custom template file for a given configuration file:

Platform
UNIX
Windows

Command
adtmplreport.sh contextfile=<CONTEXT_FILE> target=<configurationfile>
adtmplreport.cmd contextfile=<CONTEXT_FILE> target=<configurationfile>

Section 5: Advanced AutoConfig Features and Utilities

This section gives an overview of some of the useful new advanced AutoConfig features and utilities.

5.1. Running AutoConfig in Parallel Across Multiple Nodes

This feature was introduced in TXK 12.0.4 Consolidated Patch. It enables AutoConfig to be executed simultaneously across multiple nodes of an R12 E-Business Suite instance, thus reducing the maintenance downtime.

AutoConfig can be run in 'parallel mode' by issuing the following command.

On Applications tier:
On Database tier:

perl <AD_TOP>/bin/adconfig.pl contextfile=<CONTEXT_FILE> [product=<product_top>] –parallel
perl <ORACLE_HOME>/appsutil/bin/adconfig.pl contextfile=<CONTEXT_FILE> –parallel

Note: When running AutoConfig simultaneously on multiple nodes, the '-parallel' option must be specified while starting AutoConfig on every node. Otherwise the execution of AutoConfig processes on individual nodes will not be synchronized, which might result in inconsistent filesystem or database updates.

5.2. Profiling AutoConfig Run

The AutoConfig Performance Profiler feature has been introduced in TXK 12.0.4 Consolidated Patch. This feature can be used to profile an AutoConfig run and generate a consolidated report in HTML format. The report displays a summarized view listing all the product tops along with the total instantiation/execution time of the templates within them. The profile report comprises the following sections:

Summary (See a snapshot)
- This section of the report shows the profile information for all product tops processed in the current AutoConfig run. It shows the following:
  - Product Top: Short name of each product top.
  - Instantiation Time: Total time taken to instantiate templates from each product top.
  - Execution Time: Total time taken to execute scripts from each product top.
  - Time (%): Percentage of AutoConfig execution time taken to instantiate and execute scripts from each product top.
  - Status: Whether or not all the templates from each product top were successfully instantiated and executed.

The profile information for individual templates can be seen by drilling down into the product tops listed in the summary section.

Details (See a snapshot)
- This section contains the profile information for all product templates that are only instantiated/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.
  - 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 the 'profile' mode by issuing the following command:

On Application Tier:
On Database Tier:

perl <AD_TOP>/bin/adconfig.pl contextfile=<CONTEXT_FILE> [product=<product_top>] –profile
perl <ORACLE_HOME>/appsutil/bin/adconfig.pl contextfile=<CONTEXT_FILE> [product=<product_top>] –profile

5.3. Check Config Utility

The Check Config utility (adchkcfg) has been available since the base release of Oracle E-Business Suite Release 12. It is used to review the configuration changes that would take effect on an E-Business Suite instance during the next AutoConfig run. It identifies the potential changes to both the File system as well as the Database. It can be run on both the applications tier and the database tier.

The utility is located in the following location:

Tier

Application

Database

Location

<AD_TOP>/bin

<ORACLE_HOME>/appsutil/bin

The Check Config utility may be run by executing the following command:

On UNIX

adchkcfg.sh contextfile=<CONTEXT_FILE>
adchkcfg.cmd contextfile=<CONTEXT_FILE>

On Windows

This script generates both HTML and text reports. The reports 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:

File System Changes (See a snapshot)
- This report is divided into the following sections:
  - AutoConfig Context File Changes
    - Displays information about the location of the context file, the content of the currently active context file, the content of the context file that will be generated in the next AutoConfig run. In addition it also displays an HTML report highlighting the differences between the current and the new context file, if any.
  - Service Group Status
    - Displays the status of the Service Groups and the corresponding services on the applications tier. This section is present only in the report generated on the applications tier.
  - Changed Configuration Files
    - Displays a list of all the files that will be changed during an AutoConfig execution. For each file, information is displayed about the location of the runtime file, the content of the currently active file, the content of the file that will be generated in the next AutoConfig run. In addition, an HTML report highlights the differences between the current and the new configuration file, plus the location of the AutoConfig template file (if applicable).
  - New Configuration Files
    - Displays a list of all the new files that will be created during an AutoConfig execution. For each file, information is displayed about the location of the runtime file, the content of the new file and the location of the AutoConfig template file.
  - Template Customizations
  - This section has been introduced in Oracle Techstack Release Update Pack 2 for 12.1. It displays a list of all customized AutoConfig templates and reports the diff between the original AutoConfig template and the customized template.

Database Changes (See a snapshot)

This report is divided into the following sections:

Profile Value Changes
- Displays details of only those 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 details as in previous section for all Apps Database profiles managed by AutoConfig, irrespective of whether their value would change or not in the next AutoConfig run.
Other Database updates
- Displays details for important database updates (non-profile changes) 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.

The script also creates a zip file report "ADXcfgcheck.zip" that contains all the files and reports mentioned above. 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.

5.4. Context Variable Information Utility

The TXK Context Variable Information utility was introduced in TXK 12.0.4 Consolidated Patch.

This command-line utility can be used to find out detailed information about context variables and the templates in which they are used. The utility accepts all or part of a context variable name and generates an HTML or text report containing information about the matched context variables - the 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 the respective context variables are used. See a snapshot of the generated report.

The Context Variable Information utility can be executed as follows:

Source the Applications environment file as the owner of the application tier file system (APPLMGR user).
Run the technology validation utility using the following syntax:
1. The utility takes the following arguments:
- contextfile (optional): complete path to the context file. By default, it is set to the value of <CONTEXT_FILE>
- keyword (required): all or part of a context variable name
- reportType (optional): the report type. Valid values are html (default) or text
- outfile (required): the report file. If only the name and not the complete path for the report file is provided, the report will be generated in the <APPLTMP> directory.

Section 6: Using AutoConfig on an Oracle RAC Instance

This section guides you through the steps that need to be performed when your Oracle Release 12 instance is running on Oracle Real Application Clusters (Oracle RAC).

perl <FND_TOP>/bin/txkrun.pl -script=GenCtxInfRep -keyword="<keyword>"
perl <ORACLE_HOME>/appsutil/bin/txkrun.pl -script=GenCtxInfRep -keyword="<keyword>"

Note: Refer to Oracle MetaLink Note 388577.1 for converting a Release 12 single instance to Oracle RAC, implementing AutoConfig with Oracle RAC, and implementing load balancing of database connections on Oracle RAC for Release 12 application tiers.

Oracle E-Business Suite Release 12 delivers the infrastructure to generate a complete tnsnames.ora file required for Oracle RAC. This includes

Instance aliases for each database tier node
Load balance aliases with address lists for each database tier node
FNDSM and FNDFS aliases (used by the CP Service Manager) for each application tier node
Virtual hostname support

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 E-Business Suite environment.

Complete the steps in this section (in the order listed) to support AutoConfig on Oracle RAC:

Apply latest TXK AutoConfig Template patch
Update the Oracle Applications file system with the AutoConfig files by applying the latest AutoConfig Template patch (Patch 9386653 for 12.0.X customers and Patch 8919489 for 12.1.X customers) to all application tier nodes in your system. Follow the instructions described in Section 3 for applying the patch.
Review init.ora
1. AutoConfig will not overwrite your existing init.ora file. However, when no init.ora file exists, AutoConfig will generate an init.ora that is compatible with Oracle RAC. We recommend creating a backup of the existing init.ora file and let AutoConfig generate a new init.ora file. This will ensure that the init.ora file conforms to the Oracle's standards; for example, use of DB_Name as the service name or handling local and remote listeners.
Migrate AutoConfig Patch to the Database tier
1. Follow the steps in Section 3 to migrate the AutoConfig Patch to the database tier.
Run AutoConfig on all Database tier nodes
1. Run AutoConfig on all database tier nodes. Follow the instructions described in Section 2 above.

Attention: The database server instance and the database listener must remain available during the AutoConfig run. All the other database tier services should be shut down.

Run AutoConfig on the Application tier
1. Run AutoConfig on each Application tier. Use the adautocfg.sh/.cmd command described in Section 2.

Attention: The database server and the database listener must remain available during the AutoConfig run.

Restart the database listener
1. Stop and restart your database listener.

Your system is now AutoConfig-enabled with Oracle RAC. Refer to Section 2 for information on managing system configuration.

Section 7: Oracle E-Business Suite Services: Process Management

This section describes how to manage the Oracle E-Business Suite services through AutoConfig.

As mentioned in Section 2, Applications services must be shut down before running AutoConfig on the applications tier. After completion of the AutoConfig run, these services may be restarted. The scripts adstrtal.sh/cmd and adstpall.sh/cmd can be used for this purpose.

In Applications Release 12, the Applications services have been categorized into service groups, according to the type of service provided. A particular service will be started or stopped via the adstrtal or adstpall scripts only if both the service and its service group are enabled.

7.1. Modifying AutoConfig-Managed Services and Service Groups

Depending on the requirement of a particular Applications instance, it is possible to modify the set of Applications services and service groups that will be started and stopped via the adstrtal/adstpall scripts. This can be done by enabling the required services and service groups, and disabling those that are not needed.

Checking whether a Service Group/Service is enabled or disabled
1. A complete list of the status of all Service Groups and Services is available in Section 2 of the report generated by the Check Config utility (adchkcfg). For more details, please refer to Section 5.3.
2. Additionally, the log files generated by the adstrtal/adstpall scripts also provide a report containing a list of the Application service groups and the services that are managed via AutoConfig. This list also reports whether a particular service group or service is 'enabled' or 'disabled'.
Enabling or Disabling a Service Group
Enabling a Service
Disabling a Service

For example, perform the following steps to manage the service 'Oracle Metrics Server' (part of the Service Group 'Other Services') via AutoConfig.

Check the status of the service group 'Other Services'.
In case it is 'disabled', change the value of the context variable 's_other_service_group_status' to 'enabled'.
Next check the status of the service 'Oracle Metrics Server'.
If the status is set to 'disabled', change the value of the context variable 's_metsstatus' to 'enabled'.

Note: For more details on the Service Groups and Services in E-Business Suite Release 12, please refer to My Oracle Support Knowledge Document 406558.1.

7.2. Commands to Manage Oracle E-Business Suite Service Processes

Commands for managing processes on the Applications tier
1. The adstrtal/adstpall scripts can be used to start/stop all Application services managed by AutoConfig. Alternatively, it is also possible to administer the individual services separately using the respective service control scripts.
2. All scripts listed below are located in <INST_TOP>/admin/scripts.

Note: Please refer to Section 3 in My Oracle Support Knowledge Document 406558.1 for the control script names for the respective services.

Commands for managing processes on the Database tier
1. All the scripts listed below are located in
2. <RDBMS ORACLE_HOME>/appsutil/scripts/<CONTEXT_NAME>.

Note: To manage Oracle Configuration Manager (OCM) processes running on an Oracle E-Business Suite Release 12 instance, refer to the OCM documentation. OCM processes are not managed by standard service management scripts such as adstrtal.sh and adstpall.sh.

Section 8: Known Issues

This section lists any known issues with the configuration management of your Oracle E-Business Suite Release 12 environment.

On a Multi-node installation with the Forms Services and Batch Processing Services enabled on separate nodes, OAM fails to update the context variables on the Batch Processing Services node
1. Check whether the Listener Service is up on the Forms Services node. In case the service is down, start the service using one of the following options:
  1. Start the TNS listener service manually using the following command:
  - On UNIX
  - On Windows
  1. Enable management of the TNS Listener Service via the adstrtal/adstpall scripts on the Forms Services node.
    - 'Enable' the TNS Listener Service by following the steps mentioned in Section 7.
    - Stop all middle tier services using the adstpall.sh/cmd script.
    - Startup the middle tier services using the adstrtal.sh/cmd script.

AutoConfig fails to execute on the Windows Itanium platform

Apply the one-off patch, 6501658, which delivers the fix for this issue. Customers need to be on at least the 12.0.2 patchset in order to apply this one-off patch.

sh $INST_TOP/admin/scripts/adalnctl.sh start <TWO_TASK>
%INST_TOP%\admin\scripts\adalnctl.cmd start <LOCAL>

Page updated

Google Sites

Report abuse