Tuesday, August 27, 2019

Using AutoConfig to Manage System Configurations in Oracle E-Business Suite Release 12 (Doc ID 387859.1)

Using AutoConfig to Manage System Configurations in Oracle E-Business Suite Release 12

Last Updated: February 4, 2019

The most current version of this document is published as My Oracle Support Knowledge <Document 387859.1>, Using AutoConfig to Manage System Configurations in Oracle E-Business Suite Release 12 .
This document contains the following sections:
Section 1: Overview of AutoConfig Components and Tools Section 2: Using AutoConfig Tools for System Configuration Section 3: Patching AutoConfig Section 4: Customizing AutoConfig-Managed Configurations Section 5: Advanced AutoConfig Features and Utilities
Section 6: Using AutoConfig on an Oracle RAC Instance
Section 7: Oracle E-Business Suite Services: Process Management
Section 8: Known Issues
Section 9: Frequently Asked Questions
Appendix A: Specification for AutoConfig Driver File Syntax
Appendix B: Setting the PERL5LIB environment variable on the Database tier
Change Log

Conventions

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

ConventionMeaning
APPLMGRUser who owns the Applications file system (APPL_TOP and application tier technology stack)
ORACLEUser who owns the database file system (RDBMS ORACLE_HOME and database files).
CONTEXT_NAMELogical name for your Context. Default: <SID>_<hostname>
CONTEXTFull path to the context file (either Applications context file or database context file).
Default: <INST_TOP>/appl/admin/<CONTEXT_NAME>.xml and <RDBMS_ORACLE_HOME>/appsutil/<CONTEXT_NAME>.xml
Monospace TextRepresents command line text. Type this command exactly as shown.
\On UNIX, the backslash character is entered at the end of a command line to indicate continuation of the command on the next line.
AutoConfig template fileAn AutoConfig template file contains named tags, which are replaced with instance-specific information when AutoConfig runs. For example: <FND_TOP>/admin/template/afwebprf.sh
AutoConfig template files should not be edited.
Custom template fileTo customize AutoConfig-managed configuration files, copy the AutoConfig template file to a custom template file and edit the custom template file. For example:   <FND_TOP>/admin/template/custom/afwebprf.sh
When AutoConfig detects a custom template file, AutoConfig instantiates this file in place of the AutoConfig template file.
AutoConfig template directoryDirectory where Oracle delivers AutoConfig template files. There is an AutoConfig template directory for every product.
Location:   <product_top>/admin/template
                   <RDBMS ORACLE_HOME>/appsutil/template
For example:   <FND_TOP>/admin/template
             
<ORACLE_HOME>/appsutil/template
Custom template directoryDirectory where you keep your customized AutoConfig template files.
Location:   <product_top>/admin/template/custom
                   <RDBMS ORACLE_HOME>/appsutil/template/custom
For example:   <FND_TOP>/admin/template/custom
                          <ORACLE_HOME>/appsutil/template/custom
Configuration fileThe instantiated configuration file that is created when AutoConfig runs. For example: <INST_TOP>/admin/install/afwebprf.sh
< >Text enclosed in angle brackets represents a variable. Substitute a value for the variable text. Do not type the angle brackets.

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:
ComponentDescription
Applications contextAn XML repository located in the INST_TOP that contains information specific to the APPL_TOP.
Database contextAn XML repository located in the RDBMS ORACLE_HOME that contains information specific to that database tier.
AutoConfig template filesFiles containing named tags that are replaced with instance-specific information from the appropriate context ("instantiation").
AutoConfig driver filesEvery Oracle E-Business Suite product maintains a driver file used by AutoConfig. The driver file lists the AutoConfig file templates and their destination locations.
AutoConfig scriptsA set of scripts that provide a simplified interface to the AutoConfig APIs.
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.
ScriptLocationUtility
adautocfg.sh/cmdOn Applications Tier:
<INST_TOP>/admin/scripts

On Database Tier:
<RDBMS_ORACLE_HOME>/appsutil/scripts/<CONTEXT_NAME>
This script is used for running AutoConfig.

More Details
adchkcfg.sh/cmdOn Applications Tier:
<AD_TOP>/bin

On Database Tier:
<RDBMS_ORACLE_HOME>/appsutil/bin
This script may be run before running AutoConfig to review the changes on running AutoConfig. This will generate a report showing the differences between the existing configuration and what the configuration would be after running AutoConfig.

More Details
GenCtxInfRep.plOn Applications Tier:
<FND_TOP/patch/115/bin

On Database Tier:
<RDBMS_ORACLE_HOME>/appsutil/bin
This script can be used to find out detailed information about context variables and the templates in which they are used, given all or part of a context variable name as a keyword.

More Details
adtmplreport.sh/cmdOn Applications Tier:
<AD_TOP>/bin

On Database Tier:
<RDBMS_ORACLE_HOME>/appsutil/bin
This script can be used to gather information regarding the location of the AutoConfig templates, provided the location of the instantiated files and vice versa.

More Details
admkappsutil.plOn Applications Tier:
<AD_TOP>/bin
This script is used while applying patches to the database tier. Running this script generates appsutil.zip which may be copied over to the database tier to migrate the patch to the database tier.

More Details
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:
      sh <RDBMS_ORACLE_HOME>/appsutil/bin/adchkcfg.sh contextfile=<CONTEXT_FILE>
    • On Windows:
      <RDBMS_ORACLE_HOME>\appsutil\bin\adchkcfg.cmd contextfile=<CONTEXT_FILE>
  • On the Applications tier:
    • On Unix:
      sh <AD_TOP>/bin/adchkcfg.sh contextfile=<CONTEXT_FILE>
    • On Windows:
      <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:
    sh <RDBMS_ORACLE_HOME>/appsutil/scripts/<CONTEXT_NAME>/adautocfg.sh
  • On Windows:
    <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:
    sh <INST_TOP>/admin/scripts/adautocfg.sh
  • On Windows:
    <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:

TierDirectory
Application<INST_TOP>/admin/log/<MMDDhhmm>
Database<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:

TierDirectory
Application<INST_TOP>/admin/out/<MMDDhhmm>
Database<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
    restore.sh
  • On Windows
    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:
  1. Apply the TXK AutoConfig Template patchUpdate 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 27135427 for 12.1.X customers) to all application tier nodes in the Applications instance.

    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.

    Windows Itanium and Windows 2008 x86-64 customers running split tier mode on 12.0.X should apply the additional one-off Patches 12428418 and 13742583.

    Note: ADX and TXK rollup patches for configuration management have been combined.
  2. Copy AutoConfig to the RDBMS ORACLE_HOME
    Update the RDBMS ORACLE_HOME file system with the AutoConfig files by performing the following steps:
    • On the application tier (as the APPLMGR user):
      • Log in to the APPL_TOP environment (source the environment file)
      • Create appsutil.zip file
        perl <AD_TOP>/bin/admkappsutil.pl
      • This will create appsutil.zip in <INST_TOP>/admin/out
    • On the database tier (as the ORACLE user):
      • Copy or FTP the appsutil.zip file to the <RDBMS ORACLE_HOME>
        cd <RDBMS ORACLE_HOME>
        unzip -o appsutil.zip
  3. Run AutoConfig 
    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:
  1. Apply patch 6636108 on the Applications tierCustomers 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 27135427 for 12.1.X customers).

    Note: If your instance is on 12.0.X and is not upgraded to 10.1.3.3 AS patchset, Patch 4585869 needs to be applied in order to use the adbldxml utility.

  2. Copy AutoConfig to the RDBMS ORACLE_HOME 
    Update the RDBMS ORACLE_HOME file system with the new AutoConfig files delivered in the above patch following Step b in Section 3.1.

  3. Install JRE on the Database tierFollow the steps below to ensure that jre version on the applications tier and the database tier is atleast 1.5 or higher:

    • If you are using a "fully certified" platform, please refer to My Oracle Support Knowledge Document 418664.1Overview of Using Java with Oracle E-Business Suite Release 12 to install jre under the <RDBMS_ORACLE_HOME>/appsutil directory.
    • If you are using a "Database tier only" platform, please refer to My Oracle Support Knowledge Document 456197.1Using Oracle E-Business Suite Release 12.0 or 12.1 with a Database Tier Only Platform on Oracle 10g Release 2 to install jre under the <RDBMS_ORACLE_HOME>/appsutil directory.

  4. Generate the Database Context FileExecute the following command to create your Database Context File:

    perl <RDBMS_ORACLE_HOME>/appsutil/bin/adbldxml.pl
    Attention: If you build the context file for an 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.

  5. Run AutoConfig on the Database tierRun AutoConfig on the Database tier by executing the below command:

    • On Unix:
      <RDBMS_ORACLE_HOME>/appsutil/bin/adconfig.sh contextfile=<context_file>
    • On Windows:
      <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.
  1. Review your current configuration

    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.
  2. Review and migrate existing customizations

    If you implemented customizations between "Begin/End customization" blocks in the past, then you must migrate those settings now. Execute the following command:
    PlatformTierCommand
    UNIXApplication<AD_TOP>/bin/adcustomizer.sh contextfile=<CONTEXT_FILE>
     Database<RDBMS ORACLE_HOME>/appsutil/bin/adcustomizer.sh contextfile=<CONTEXT_FILE>
    WindowsApplication<AD_TOP>\bin\adcustomizer.cmd contextfile=<CONTEXT_FILE>
     Database<RDBMS ORACLE_HOME>\appsutil\bin\adcustomizer.cmd contextfile=<CONTEXT_FILE>

    The adcustomizer script:
    1. Detects all configuration files that have "Begin/End customizations" blocks.
    2. Copies the corresponding AutoConfig template files to custom template files.
    3. Appends the contents in the "Begin/End customizations" blocks to the end of the custom template files.
    4. 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:
  1. Changing the value of an existing context variable
    1. Edit the context variable value

      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 

      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.
  2.     
  3. Adding a new context variable to the context file
    1. Add the context variable

      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.
    2. Run AutoConfig

      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.
  4.     
  5. 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:

    1. 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:
             
      PlatformTierCommand
      UNIXApplication<AD_TOP>/bin/adtmplreport.sh contextfile=<CONTEXT_FILE> target=<configurationfile>

      Database<RDBMS ORACLE_HOME>/appsutil/bin/adtmplreport.sh contextfile=<CONTEXT_FILE> target=<configurationfile>
      WindowsApplication<AD_TOP>\bin\adtmplreport.cmd contextfile=<CONTEXT_FILE> target=<configurationfile>

      Database<RDBMS ORACLE_HOME>\appsutil\bin\adtmplreport.cmd contextfile=<CONTEXT_FILE> target=<configuration>
    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
    • On Windows
      %AD_TOP%\bin\adtmplreport.cmd contextfile=%CONTEXT_FILE% \   
      target=%INST_TOP%\admin\install\afwebprf.cmd
    • 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:
      ad admin/template adconfig.txt INSTE8 <s_at>/admin adconfig.txt 600 LOCK
    1. Create the custom template directory
      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
      mkdir $FND_TOP/admin/template/custom
    • On Windows
      mkdir %FND_TOP%\admin\template\custom
    1. 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
      cp -i <AutoConfig template file> <custom template file>
    • For example:
      cp -i $FND_TOP/admin/template/afwebprf.sh \
      $FND_TOP/admin/template/custom/afwebprf.sh
    • On Windows
      copy <AutoConfig template file> <custom template file>
      For example:
      copy %FND_TOP%\admin\template\afwebprf.cmd \
      %FND_TOP%\admin\template\custom\afwebprf.cmd
    1. 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.

    1. Verify your customizations
      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>
    2. Run AutoConfig
      Run AutoConfig as described in Section 2. When AutoConfig runs, it instantiates any custom template file in place of the corresponding AutoConfig template file.
  1. Creating a customer-owned AutoConfig template file
    You can create an AutoConfig template file of your own. This will enable you to develop custom applications that AutoConfig can configure and maintain.
    Perform the following tasks in the order listed:
    1. Define a product_top
      Use the Oracle Applications Manager Context Editor to add your custom product_top to the context file. Refer to the Help pages available in Oracle Applications Manager. The relevant information for adding custom context variables is located in the "System Configuration"> "AutoConfig"> "Manage Custom Parameters" section. Choose the variable type "PROD_TOP" when adding the product_top variable. The default value for the product_top variable must be set to '%s_at%/<product name>/12.0.0'.

      For example, define the product top for the product 'my' as follows:
       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
    2. Create the customer-owned AutoConfig template directory
      Create the directory where your AutoConfig template files will reside. Execute the following command as the applmgr user:

      • On UNIX
        mkdir <c_mytop>/admin/template
      • On Windows
        mkdir <c_mytop>\admin\template
    3. Develop the customer-owned AutoConfig template file
      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.For example, create and edit the file
      <c_mytop>/admin/template/myTemplate.txt
    4. Create the customer-owned AutoConfig driver directory
      Create the directory where your AutoConfig driver file will reside. Execute the following command as the applmgr user:

      • On UNIX
        mkdir <c_mytop>/admin/driver
      • On Windows
        mkdir <c_mytop>\admin\driver
    5. Develop the customer-owned AutoConfig driver file
      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.For example, to have AutoConfig instantiate the above example template file, the driver file would need to contain this line:
      my admin/template myTemplate.txt INSTE8 <s_pt> myConfiguration.txt 660

4.3. Advanced Features of AutoConfig Customizations

This section discusses advanced features when using AutoConfig Customizations.
  1. Debugging customizations
    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
      <AD_TOP>/bin/adconfig.sh -nocustom contextfile=<CONTEXT_FILE>
    • On Windows
      <AD_TOP>\bin\adconfig.cmd -nocustom contextfile=<CONTEXT_FILE>
  2. Preserving customizations after updates
    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.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.
  3. Reports
    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
    The report utility is located at:
    TierLocation
    Application<AD_TOP>/bin
    Database<RDBMS ORACLE_HOME>/appsutil/bin


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

    PlatformCommand
    UNIXadtmplreport.sh contextfile=<CONTEXT_FILE> listcustom
    Windowsadtmplreport.cmd contextfile=<CONTEXT_FILE> listcustom

    To list all configurations files, their AutoConfig template files and their custom template files:
    PlatformCommand
    UNIXadtmplreport.sh contextfile=<CONTEXT_FILE>
    Windowsadtmplreport.cmd contextfile=<CONTEXT_FILE>


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

    PlatformCommand
    UNIXadtmplreport.sh contextfile=<CONTEXT_FILE> template=<templatefilepath>
    Windowsadtmplreport.cmd contextfile=<CONTEXT_FILE> template=<templatefilepath>


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

    PlatformCommand
    UNIXadtmplreport.sh contextfile=<CONTEXT_FILE> target=<configurationfile>
    Windowsadtmplreport.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:
    perl <AD_TOP>/bin/adconfig.pl contextfile=<CONTEXT_FILE> [product=<product_top>] –parallel
  • On Database tier:
    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
    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
    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:
    perl <AD_TOP>/bin/adconfig.pl contextfile=<CONTEXT_FILE> [product=<product_top>] –profile
  • On Database Tier:
    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:
TierLocation
Application<AD_TOP>/bin
Database<ORACLE_HOME>/appsutil/bin
The Check Config utility may be run by executing the following command:
  • On UNIX
    adchkcfg.sh contextfile=<CONTEXT_FILE>
  • On Windows
    adchkcfg.cmd contextfile=<CONTEXT_FILE>
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
    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 CustomizationsThis 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
    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.
The Context Variable Information utility can be executed as follows:
  1. Source the Applications environment file as the owner of the application tier file system (APPLMGR user).
  2. Run the technology validation utility using the following syntax:

    • On Applications Tier:
      perl <FND_TOP>/bin/txkrun.pl -script=GenCtxInfRep -keyword="<keyword>"
    • On Database Tier:
      perl <ORACLE_HOME>/appsutil/bin/txkrun.pl -script=GenCtxInfRep -keyword="<keyword>"
    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).

Note: Refer to My Oracle Support Knowledge Document 388577.1, Using Oracle 10g Release 2 Real Application Clusters and Automatic Storage Management with Oracle E-Business Suite Release 12, 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:
  1. 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 27135427 for 12.1.X customers) to all application tier nodes in your system. Follow the instructions described in Section 3 for applying the patch.
  2. Review init.ora
    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. 

  3. Migrate AutoConfig Patch to the Database tier
    Follow the steps in Section 3 to migrate the AutoConfig Patch to the database tier.
  4. Run AutoConfig on all Database tier nodes 
    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.
  5. Run AutoConfig on the Application tier
    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.
  6. Restart the database listener
    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.
  1. Checking whether a Service Group/Service is enabled or disabled

    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.

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

  2. Enabling or Disabling a Service Group

    • Check the value of the 'status' context variable corresponding to the service group.
    • Change the value of this variable to 'enabled' to enable the service group, or to 'disabled' to disable the service group.
  3. Enabling a Service

    • Check the value of the 'status' context variable corresponding to the service group to which the service belongs.
    • If the service group is 'disabled', enable the service group as described above.
    • Change the value of the 'status' context variable corresponding to the service to 'enabled' if it is not already set to 'enabled'.
  4. Disabling a Service
    • Check the value of the 'status' context variable corresponding to the service.
    • Change the value of this variable to 'disabled' if it is not already set to 'disabled'.
For example, perform the following steps to manage the service 'Oracle Metrics Server' (part of the Service Group 'Other Services') via AutoConfig.
  1. Check the status of the service group 'Other Services'.
  2. In case it is 'disabled', change the value of the context variable 's_other_service_group_status' to 'enabled'.
  3. Next check the status of the service 'Oracle Metrics Server'.
  4. 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

  1. Commands for managing processes on the Applications tierThe 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.

    All scripts listed below are located in <INST_TOP>/admin/scripts.
    FunctionalityUNIX CommandWindows Command
    Start Applications servicesadstrtal.shadstrtal.cmd
    Stop Applications servicesadstpall.sh adstpall.cmd 
    Start individual service<control_script> start <control_script> start
    Stop individual service<control_script> stop  <control_script> stop 


    Note: Please refer to Section 3 in My Oracle Support Knowledge Document 406558.1 for the control script names for the respective services.
  2. Commands for managing processes on the Database tier

    All the scripts listed below are located in
    <RDBMS ORACLE_HOME>/appsutil/scripts/<CONTEXT_NAME>.
  3. FunctionalityUNIX CommandWindows Command
    Start database listener process addlnctl.sh start <SID> addlnctl.cmd start <SID>
    Stop database listener process addlnctl.sh stop <SID> addlnctl.cmd stop <SID>
    Start database processaddbctl.sh start addbctl.cmd start
    Stop database processaddbctl.sh stop addbctl.cmd stop
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.
  1. 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 

    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
      sh $INST_TOP/admin/scripts/adalnctl.sh start <TWO_TASK>
    • On Windows
      %INST_TOP%\admin\scripts\adalnctl.cmd start <LOCAL>
    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.

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

SECTION 9: FREQUENTLY ASKED QUESTIONS

9.1. Overview and Terminology

  1. What is AutoConfig?
  2. What is the difference between the application tier and the database tier?
  3. How can I identify the application tier and the database tier in a multi-node system?
  4. How do I configure AutoConfig for a multi-node system?
  5. What user do I log in as to use AutoConfig in a typical multi-node system?
  6. What does the term "Context name" mean?
  7. What is the environment variable $INST_TOP?
  8. What are the basic components of AutoConfig ?
  9. What are the different AutoConfig scripts and what do they do?

9.2. The Context File

  1. What is the naming convention for Applications Context file?
  2. How do I make changes to the Applications Context file?
  3. Can I use adbldxml.pl to generate context files in Release 12?
  4. How do I recover the Applications context file if it is lost or deleted accidentally?

9.3. Running AutoConfig

  1. When should I run AutoConfig?
  2. Which files and profile options are changed when I run AutoConfig?
  3. Where is the log file located that AutoConfig creates?
  4. Which directories based on the <Context_Name> will AutoConfig create?
  5. What is the location of control scripts that are used to start the services?
  6. How do I roll back an AutoConfig session?

9.4. Customizations

  1. How do I preserve customizations to an AutoConfig-maintained environment?
  2. What are "Customizable Templates"?
  3. What are "Non-Customizable templates"?
  4. How do I determine whether it is a "Customizable/Non-Customizable" template?
  5. What is the mechanism for sending apps user/password to a new custom template?
  6. What do I do when a patch or Oracle documentation instructs me to manually modify an AutoConfig-maintained file?

9.5. Patching AutoConfig

  1. How do I get the latest changes to AutoConfig?
  2. How do I apply the latest AutoConfig patch?

9.6. Net Services

  1. What is the Net Services Topology Data Model?
  2. When is the Net Services Topology Data Model seeded?
  3. What mechanism is used to generate the tnsnames.ora file?
  4. How do I seed the Net Services Topology Data Model?
  5. When do I need to deregister a database tier or an application tier?
  6. How do I deregister an application tier from the Net Services Topology Data Model?
  7. How do I deregister a database tier from the Net Services Topology Data Model?
  8. When do I need to purge the complete Net Services Topology Data Model?
  9. How do I purge the complete Net Services Topology Data Model?
  10. How do I seed the Net Services Topology Data Model after purging it?
  11. I want to deregister an application tier or a database tier from the Net Services Topology Data Model. I can't use the adgentns.pl because I already decommissioned the tier or removed the context file. How can I deregister the tier?
  12. I want to purge the complete Net Services Topology Data Model. I can't use the adgentns.pl script because I removed the relevant context file(s). How can I purge the Data Model?
  13. How do I configure AutoConfig to generate the failover aliases?
  14. For which database versions can I define failover aliases?

9.7. Database Connectivity

  1. Should the database server remain available during the AutoConfig run?
  2. What is the use of the context variable s_apps_jdbc_connect_descriptor?
  3. When do I need to reset (empty) the context variable s_apps_jdbc_connect_descriptor?
  4. Does AutoConfig support spfiles?
  5. What steps do I need to follow to maintain my database connectivity when I migrate my database from one host/platform to another?
  6. I migrated my database tier to a new host/platform, but the application tier still tries to connect to the old database. How can I fix this situation, so that the application tier connects to the new database?

9.8. Oracle RAC

  1. My Release 12 instance is configured with RAC. Now I want to migrate to AutoConfig. How do I achieve that?
  2. My Release 12 instance is configured as non-RAC. Now I want to migrate to RAC using AutoConfig. What steps should I follow?
  3. I applied all the required RAC patches, but my TWO_TASK variables still point to the instance aliases. How can I point them to load balanced aliases?
  4. My RAC environment uses an spfile. How do I ensure that my spfile is in sync with the init.ora files?

9.9. Windows Specific Requirements

  1. What is the correct setting for MSDEVDIR? 
  2. Can I use the perl shipped by MKS to run adconfig.cmd on Windows?

9.10. Troubleshooting

  1. What should I do if my AutoConfig script exits with non-zero status?

9.1. Overview and Terminology

1) What is AutoConfig?

Answer:
AutoConfig is a configuration tool that automates the configuration of an Oracle E-Business Suite instance. The information required for configuring an Applications system is collected into an XML repository, called the Applications context. There is one Applications context for each application tier, and one for each database tier. When AutoConfig runs, it uses information from the Applications context file to generate all configuration files, and update database profiles.

Back to FAQ List

2) What is the difference between the application tier and the database tier?

Answer:
Before we can answer that, let's define a few terms in the context of the Release 12 architecture:
  • server is the traditional term for a process that provides a particular functionality. This term, in the sense of a denoting a single process, is less appropriate for some components of the Release 12 architecture, in which case the replacement term of service or service group is used.
  • node is a logical grouping of servers, and therefore fundamentally a software concept rather than a hardware concept, although it is often also used to refer to the machine on which a particular node is installed.
  • tier is a logical grouping of servers or services, potentially spread across more than one physical machine.
Now let's answer the question.
  • The application tier (sometimes called the middle tier) consists of a number of servers or services that define the set of processes that will be started on each application node, and can be activated or deactivated according to the function the node is to perform. These include Forms services, Web services, and Batch Processing services (Concurrent Processing server). A key role of these services is to provide communication between the desktop tier and the database tier.
  • The database tier consists of the database server, which stores all the data of the Release 12 system in an Oracle database.
The primary location of the files used by the application tier servers is the APPL_TOP, whereas the primary location of the files used by the database tier server is the Oracle10g ORACLE_HOME.

Back to FAQ List

3) How can I identify the application tier and the database tier in a multi-node system?

Answer:
A node can support one or more servers (or services), and can therefore belong to one or more tiers.In a single-node system, that node belongs to both the application tier and the database tier, since all servers are contained on that single node.
In a multi-node system, each node supports one or more servers (or services), and belongs to one or both tiers. If the node provides any of the application tier services, including Forms services, Web services, or Batch Processing services (Concurrent Processing server), then there is an APPL_TOP on the node, it belongs to the application tier, and is considered an application tier server node. If the node contains the database server, which means that there is an Oracle10g ORACLE_HOME and the Applications database instance on the node, then the node belongs to the database tier, and is considered a database server node.
Let's analyze a common configuration where the database server and the Concurrent Processing server exist on one node (Node 1), and the other servers exist on a second node (Node 2). Since Node 1 contains both an application tier server (Concurrent Processing server) and the database server, Node 1 belongs to both the database tier and the application tier. Since Node 2 contains only application tier servers, Node 2 belongs only to the application tier.
Back to FAQ List

4) How do I configure AutoConfig for a multi-node system?

Answer:
AutoConfig is enabled by default on every application tier node in Oracle E-Business Suite Release 12.
Back to FAQ List

5) What user do I log in as to use AutoConfig in a typical multi-node system?

Answer:
For nodes running Windows, there is only one user that owns both the application tier servers and the database server, so you would log in as that user.
For nodes running UNIX (including Linux), if you want to configure the application tier servers, log in as the user that owns the application tier servers (often referred to as the applmgr user). If you want to configure the database server, log in as the user that owns the database server (often referred to as the oracle user). Note that the applmgr user and the oracle user can be the same user, or different users.
Back to FAQ List

6) What does the term "<Context_Name>" mean?

Answer:
The "<Context_Name>" is the logical name for your context repository. The default value for <Context_Name> is <SID>_<hostname>.
Back to FAQ List

7) What is the environment variable $INST_TOP?

Answer:
New in Release 12, the Instance Top ($INST_TOP) is the central location for all the instance-specific information. The location is pointed to by the context variable s_config_home.
Back to FAQ List

8) What are the basic components of AutoConfig?

Answer:
ComponentsLocationDescription
Applications ContextOn the application tier:
<INST_TOP>/appl/adminOn the database tier:
<RDBMS ORACLE_HOME>/appsutil
 
An XML repository (<CONTEXT_NAME>.xml) contains information specific to that Applications instance.
Do not manually update this file!
AutoConfig Template FilesOn the application tier:
<PROD_TOP>/admin/template
For example:
<AD_TOP>/admin/template
<FND_TOP>/admin/template
On the database tier:
<RDBMS ORACLE_HOME>/appsutil/template
Include named tags which are replaced with instance-specific information from the Applications Context. There is one template file for each configuration file.

For example:
apps_nt.conf 
apps_ux.conf
AutoConfig File DriverOn the application tier:
<PROD_TOP>/admin/driver 

For example:
<AD_TOP>/admin/driver/adtmpl.drv
<FND_TOP>/admin/driver/fndtmpl.drv On the database tier:
<RDBMS ORACLE_HOME>/appsutil/template
Used by AutoConfig to list the AutoConfig Template Files, their destination locations, and the commands to be executed, for example, the commands to update profile options. Every Product Top contains its own AutoConfig File Driver.
AutoConfig ScriptsOn the application tier:
<AD_TOP>/binOn the database tier:
<RDBMS ORACLE_HOME>/appsutil/bin
Provide a simplified 
interface to the AutoConfig APIs.
For example:
adautocfg.sh/adautocfg.cmd 
adconfig.sh/adconfig.cmd 
Back to FAQ List

9) What are the different AutoConfig scripts and what do they do?

Answer:
The scripts are listed in the following table.
Note: .sh scripts are for UNIX users and .cmd scripts are for Windows users.

ScriptsLocationDescription
adautocfg.shadautocfg.cmdOn the application tier:
<INST_TOP>/admin/scripts On the database tier:
<RDBMS ORACLE_HOME>/appsutil/
scripts/<CONTEXT_NAME>
A wrapper script that calls adconfig.sh/adconfig.cmd. Instantiates template files with values specific to the instance (taken from the Applications for the application tier and the database context for the database tier). Updates configuration files and profile options.
adconfig.shadconfig.cmdOn the application tier:
<AD_TOP>/binOn the database tier:
<RDBMS ORACLE_HOME>/appsutil/bin/
A wrapper script that calls adconfig.pl. In earlier versions of AutoConfig adconfig.sh/ adconfig.cmd used to call the Java API to start AutoConfig.
adconfig.plOn the application tier:
<AD_TOP>/binOn the database tier:
<RDBMS ORACLE_HOME>/appsutil/bin
 
A wrapper script that calls the Java API to start AutoConfig.
adchkcfg.shadchkcfg.cmdOn the application tier:
<AD_TOP>/binOn the database tier:
<RDBMS ORACLE_HOME>/appsutil/bin
Generates a report that highlights differences between the original config files and AutoConfig-generated config files. The report is named cfgcheck.html. It is located under:
On the application tier:
<INST_TOP>/admin/
/out/<MMDDhhmm>

On the database tier:
<RDBMS ORACLE_HOME>/appsutil/out/
<CONTEXT_NAME>/<MMDDhhmm>
 

Back to FAQ List

9.2. The Context File

1) What is the naming convention for the application tier context file?

Answer:
The default name for the context file is <CONTEXT_NAME>.xml.
Back to FAQ List

2) How can I make changes to a context file?

Answer:
In Oracle Applications Manager (OAM), navigate to Site Map. Click on AutoConfig. Click on Edit Parameters to edit the relevant context file.
Attention: Manually editing a context file is not supported. Many context variables have dependencies between each other. The OAM AutoConfig resolves all these dependencies when changing the value of a variable. Manually editing the context file could bring the data into an inconsistent state.
Back to FAQ List

3) Can I use adbldxml.pl to generate context files in Release 12?

Answer: 
The adbldxml.pl utility can be used to generate the context file on the database tier only. It is commonly used when migrating AutoConfig to a database tier not created using Rapid Install or when upgrading a database tier from Applications 11i to EBusiness Suite Release 12. This utility is not supported on the applications tier.
Back to FAQ List

4) How do I recover the Applications context file if it is lost or deleted accidentally?

Answer:
The Applications context file can be retrieved by running the adclonectx.pl script.
To retrieve the applications tier context file,
  • Execute the following command on the applications tier.

    perl <COMMON_TOP>/clone/bin/adclonectx.pl retrieve
  • On being prompted for the context file to be retrieved, select the option of retrieving the applications tier context file that has been lost and retrieve it to the default location specified by the script.
The above command can be used only when the <INST_TOP> is still intact. In case the <INST_TOP> has also been lost accidentally, the applications tier context file may be retrieved as follows:
  • Execute the following command on the database tier:
    perl <ORACLE_HOME>/appsutil/clone/bin/adclonectx.pl retrieve
  • On being prompted for the context file to be retrieved, select the option of retrieving the applications tier context file that has been lost.
  • While confirming the location for the context file, set it to any existing directory with write permission.
  • Once the context file has been generated in the specified location, move it to the location specified for the context file in the context variable 's_contextfile'.
To retrieve the database tier context file,
  • Execute the following command on the database tier:
    perl <ORACLE_HOME>/appsutil/clone/bin/adclonectx.pl retrieve
  • On being prompted for the context file to be retrieved, select the database tier context file and retrieve it to the default location specified by the script.
Back to FAQ List

9.3. Running AutoConfig

1) When should I run AutoConfig?

Answer:
You should run AutoConfig in the following cases:
  • You made updates to a context file (via Oracle Applications Manager).
  • A My Oracle Support Knowledge Document note instructs you to run AutoConfig as part of an upgrade, migration, cloning and/or configuration process.
  • The README of an Oracle patch instructs you to run AutoConfig after the application of the patch.
  • You apply any ADX product patch.
Back to FAQ List

2) Which files and profile options are changed when I run AutoConfig?

Answer:
Run the adchkcfg utility to get an HTML report that lists all the files and profile options that get changed when you run AutoConfig.For instructions on how to run the adchkcfg utility and a discussion about the report that the utility generates, refer to Section 5.3.
Back to FAQ List

3) Where is the log file located that AutoConfig creates?

Answer:
The log file that AutoConfig creates is located at:On the application tier:
<INST_TOP>/admin/log/<MMDDhhmm>/adconfig.log
On the database tier:
<RDBMS ORACLE_HOME>/appsutil/log/<CONTEXT_NAME>/<MMDDhhmm>/adconfig.log
where: <MMDDhhmm> = (month, day, hour, and minute of the AutoConfig run)
Back to FAQ List

4) Which directories based on the <Context_Name> will AutoConfig create?

Answer:
AutoConfig creates the following directories based on the <CONTEXT_NAME>:

Instance Top: <INSTALL_BASE>/inst/apps/<CONTEXT_NAME>
Back to FAQ List

5) What is the location of control scripts that are used to start the services?

Answer:The control scripts for starting/stopping the services are located at <INST_TOP>/admin/scripts. This location is also pointed by an environment variable $ADMIN_SCRIPTS_HOME.
Back to FAQ List

6) How can I roll back an AutoConfig session?

Answer:
All backup configuration files from each AutoConfig session are stored in:
On the application tier:
<INST_TOP>/admin/out/<MMDDhhmm>
On the database tier:
<RDBMS ORACLE_HOME>/appsutil/out/<CONTEXT_NAME>/<MMDDhhmm>
where: <MMDDhhmm> = (month, day, hour, and minute of the AutoConfig run)
You can run restore.sh (UNIX) or restore.cmd (Windows) to roll back an AutoConfig session.
Back to FAQ List

9.4. Customizations

1) How do I preserve customizations to an AutoConfig-maintained environment? 

Answer:
Refer to Section 4 for details on how to implement customizations.
Back to FAQ List

2) What are customizable templates?

Answer:
These are templates to which customizations can be added and recognized by AutoConfig.
Back to FAQ List

3) What are non-customizable templates?

Answer:
These are templates that do not support customizations. Any customizations done on these templates are not recognized by AutoConfig.

Back to FAQ List

4) How can I determine whether a template is customizable or non-customizable?

Answer:
If a keyword "LOCK" is present at the end of the file entry in the respective driver, then it is a non-customizable template. If the "LOCK" keyword is not seen, then that template can be customized.

For example:
fnd admin/template apps_conf_1013.tmp INSTE8 <s_ora_config_home>/10.1.3/Apache/Apache/conf apps.conf 600 LOCK
Therefore, apps_conf_1013.tmp is a non-customizable template.Back to FAQ List

5) What is the mechanism for sending the Applications user name and password to a new custom template?

Answer:
In Release 11i, the APPS user name and password were passed as command line arguments to the calling script. In Release 12, the APPS user name and password are passed via standard input instead, to increase security.
Back to FAQ List

6) What do I do when a patch or Oracle documentation instructs me to manually modify an AutoConfig-maintained file?

Answer:
Log a Service Request with Oracle Support to request incorporation of the modification in the relevant AutoConfig template.
Back to FAQ List

9.5. Patching AutoConfig

1) How do I obtain the latest updates to AutoConfig?

Answer:
Updates to AutoConfig are delivered in TXK product patches, which deliver the patches for ADX and TXK templates as well as for AutoConfig. Patch 9386653 delivers the latest TXK product patches for 12.0.X. Patch 27135427 contains the latest TXK product patches for 12.1.X customers).
Back to FAQ List

2) How do I apply the latest AutoConfig patch?

Answer:
In order to apply the latest AutoConfig Template patch (Patch 9386653 for 12.0.X customers and Patch 27135427 for 12.1.X customers), perform the steps in the order listed in Section 3. This patch is required only for 12.0.X.Back to FAQ List

9.6. Net Services

1) What is the Net Services Topology Data Model?

Answer:
The Net Services Topology Data Model stores the entire topological information about a single Oracle E-Business Suite instance. The data model stores information about each node in the Oracle E-Business Suite instance, which is then used to generate Net Service configuration files such as tnsnames.ora.The Net Services Topology Data Model stores the following information:
  • Database tier: Hostname, Database SID, Database Name, Instance Name, TNS Descriptors
  • Application tier: Hostname, FNDFS and FNDSM alias descriptors
AutoConfig seeds the data model with relevant data.
Back to FAQ List

2) When is the Net Services Topology Data Model seeded?

Answer:
The Net Services Topology Data Model is seeded (updated) every time you run AutoConfig on the respective tier. Every time you run AutoConfig on the database tier, the relevant data is seeded for the database tier. Every time you run AutoConfig on the application tier, the relevant data is seeded for the application tier.Back to FAQ List

3) What mechanism is used to generate the tnsnames.ora file?

Answer:
AutoConfig runs the adgentns.pl script that dynamically generates the tnsnames.ora file. This script was introduced to support enhanced configuration scenarios such as Oracle RAC.
Back to FAQ List

4) How do I seed the Net Services Topology Data Model?

Answer:
The Net Services Topology Data Model can be seeded by running AutoConfig on the database tier, then the application tier. Also see Question 2.
Back to FAQ List

5) When do I need to deregister a database tier or an application tier?

Answer:
You have to deregister a tier from the Net Services Topology Data Model in one of the following cases:
  • You want to delete an application tier
  • Your database is upgraded/migrated resulting in a change in one of the following parameters:
    • Database Host
    • Database Port
    • Database Name
    • Database SID
You should deregister the tier before the tier is decommissioned.
Back to FAQ List

6) How do I deregister an application tier from the Net Services Topology Data Model?

Answer:
To deregister the current application tier from the Net Services Topology Data Model, invoke the following command:
perl <AD_TOP>/bin/adgentns.pl contextfile=<CONTEXT_FILE> -removeserver
Back to FAQ List

7) How do I deregister a database tier from the Net Services Topology Data Model?

Answer:
To deregister the current database tier from the Net Services Topology Data Model, invoke the following command:
perl <RDBMS ORACLE_HOME>/appsutil/bin/adgentns.pl contextfile=<CONTEXT_FILE> -removeserver
Back to FAQ List

8) When do I need to purge the complete Net Services Topology Data Model?

Answer:
You need to purge the complete Net Services Topology Data Model when the database name is changed as a result of a database upgrade or migration.Back to FAQ List

9) How do I purge the complete Net Services Topology Data Model?

Answer:
To purge the complete Net Services Topology Data Model, run the following command:
perl <AD_TOP>/bin/adgentns.pl contextfile=<CONTEXT_FILE> -removesystem
Back to FAQ List

10) How do I seed the Net Services Topology Data Model after purging it?

Answer:
See Question 4 above, "How do I seed the Net Services Topology Data Model?".Back to FAQ List

11) I want to deregister an application tier or a database tier from the Net Services Topology Data Model. I can't use the adgentns.pl script because I already decommissioned the tier or removed the context file. How can I deregister the tier?

Answer:
In this case you can use the PL/SQL API. Perform the following steps in the order listed:
  1. Locate the system name:
  • The system name is the database name
  • Obtain it by running the following SQL query:
    select DB_NAME from FND_DATABASES;
  1. Locate the server name corresponding to the tier in question:
  • Run this SQL query on the database tier:
    select NAME, SERVER_TYPE from FND_APP_SERVERS, FND_NODES 
    where FND_APP_SERVERS.NODE_ID = FND_NODES.NODE_ID and 
         SERVER_TYPE='DB' and FND_NODES.NODE_NAME=upper('hostname');
  • Run this SQL query on the application tier:
    select NAME, SERVER_TYPE from FND_APP_SERVERS, FND_NODES 
    where FND_APP_SERVERS.NODE_ID = FND_NODES.NODE_ID and 
         SERVER_TYPE='APPS' and FND_NODES.NODE_NAME=upper('hostname');
  1. Run the following PL/SQL block:
    begin
    FND_NET_SERVICES.remove_server(SYSTEM_NAME, SERVER_NAME);
    end;
    /
    commit;
    /
Back to FAQ List

12) I want to purge the complete Net Services Topology Data Model. I can't use the adgentns.pl script because I removed the relevant context file. How can I purge the Data Model?

Answer:
In this case, you can use the PL/SQL API. Perform the following steps in the order listed:
  • Locate the System Name:
    • The System name is the database name
    • Obtain it by running the following SQL query:
      select DB_NAME from FND_DATABASES;
  • Run the following PL/SQL block:
    begin
    FND_NET_SERVICES.remove_system(SYSTEM_NAME);
    end;
    /
    commit;
    /
Back to FAQ List

13) How do I configure AutoConfig to generate failover aliases?

Answer:
To generate the failover aliases, update the database tier context variable s_alt_service_instances.
You can specify a comma-separated description list of "servicename:instance" to manage connect time failover. For example:
'SERVICE_NAME:INSTANCE_NAME1,SERVICE_NAME:INSTANCE_NAME2'
This will generate a TNS alias in the tnsnames.ora file that fails over to INSTANCE_NAME1 when the current instance is not available. If INSTANCE_NAME1 is not available, failover is to INSTANCE_NAME2 instead.
To set up the failover listing, perform the following steps in the order listed:
  1. Update the context variable s_alt_service_instances in the database tier context file, applying the failover rules as described above
  2. Run AutoConfig on all database tiers
  3. Run AutoConfig on all application tiers
These steps will generate the failover TNS alias <INSTANCE_NAME>_FO with a description list as configured in s_alt_service_instances. Before you can use these aliases, you will have to set the two task variable s_tool_twotask.
Check the question "For which database versions can I define failover aliases" for information about the availability of failover aliases on different database versions.
Note: The generated alias <INSTANCE_NAME>_FO can only be used for failover.
Back to FAQ List

14) For which database versions can I define failover aliases?

Answer:
You can generate failover aliases for all database versions that are 8.1.7.4 or higher. Oracle E-Business Suite Release 12 uses the Oracle 10g Release 2 database.
Back to FAQ List

9.7. Database Connectivity

1) Does the database server need to be available during the AutoConfig run?

Answer:
Yes. The database server and database listener must remain available when AutoConfig is run on either the database tier or application tier.Back to FAQ List

2) What is the purpose of the context variable s_apps_jdbc_connect_descriptor?

Answer:
s_apps_jdbc_connect_descriptor stores the connect string used for all JDBC connections. The value for this context variable is generated by AutoConfig.When the value is reset (empty), AutoConfig tries to connect to the database using the s_dbSid, s_dbhost and s_dbport context variables. See next question.
Back to FAQ List

3) When do I need to reset (empty) the context variable s_apps_jdbc_connect_descriptor?

Answer:
You should reset the value for s_apps_jdbc_connect_descriptor to an empty value (" "), when one of the following values changes:
  • Database Host
  • Database Port
Back to FAQ List

4) Does AutoConfig support spfiles?

Answer:
AutoConfig currently does not support spfiles. It only supports the init.ora file.Back to FAQ List

5) What steps do I need to follow to maintain my database connectivity when I migrate my database from one host/platform to another?

Answer:
Perform the steps in the order listed:
  • Before the migration:
    1. Deregister the database tier from the Net Services Topology Data Model. Refer to the question "How do I deregister a database tier from the Net Services Topology Data Model?" 
  • After the migration:
    1. Reset the context variable s_apps_jdbc_connect_descriptor in the context file for the application tier to an empty string.
    2. Update the context variables s_dbhost and s_dbport in the context file for the application tier to reflect the new values in the middle tier context file.
Back to FAQ List

6) I migrated my database tier to a new host/platform, but the application tier still tries to connect to the old database. How can I fix this situation, so that the application tier connects to the new database?

Answer:
Your old database tier is still registered in the Net Services Topology Data Model. Perform the following steps:
  • You have to clean up the data model by following the steps described in the question: "How do I purge the complete Net Services Topology Data Model?".
  • Perform the step described in the question: "How do I seed the Net Service Topology Data Model?"
Back to FAQ List

9.8. Oracle RAC

1) My Release 12 instance is configured with Oracle RAC. Now I want to migrate to AutoConfig. How do I achieve that?

Answer:
AutoConfig is already enabled by default in your Release 12 instance.Back to FAQ List

2) My Release 12 instance does not currently utilize Oracle RAC. I want to migrate to Oracle RAC using AutoConfig. What steps should I follow?

Answer:
To migrate an Oracle E-Business Suite Release 12 instance to Oracle RAC, follow the instructions described in My Oracle Support Knowledge Document 388577.1, Using Oracle 10g Release 2 Real Application Clusters and Automatic Storage Management with Oracle E-Business Suite Release 12.Back to FAQ List

3) I applied all the required Oracle RAC patches, but my TWO_TASK variables still point to the instance aliases. How can I point them to the load-balanced aliases?

Answer:
Update your application tier context file and set the values of the following context variables to the desired load balanced alias names:
  • s_tools_twotask
  • s_weboh_twotask
Back to FAQ List

4)My RAC environment uses an spfile. How do I ensure that my spfile is in sync with the init.ora files?

Answer:
On a RAC environment, AutoConfig creates the following init.ora files containing values for database parameters:
  • init<s_dbSid>.ora: This file contains database parameters specific to RAC configuration.
  • <s_dbSid>_APPS_BASE.ora: This file contains generic database parameters that are applicable for both non-RAC and RAC configurations.

  • Any additional database parameter values may be set by specifying them in the ifile. The location of the ifile is specified by the context variable 's_init_ifile'.
Perform the following steps to sync up the spfile with the init.ora files.
  • Case 1: To sync up the spfile with the new init.ora files created by running AutoConfig

    1. Generate the pfile from the existing spfile by executing the following command in the database.
      SQL> create pfile='<pfile_name>' from spfile;
      Note: The <pfile_name> provided should be different from init<s_dbSid>.ora. Otherwise, it would overwrite the existing init<s_dbSid>.ora file generated in the last AutoConfig run.

    2. Move the existing init<s_dbSid>.ora file and <s_dbSid>_APPS_BASE.ora files to some other location. This is required since AutoConfig will create new init.ora files only if they are not already present.
    3. Run AutoConfig to create the new init<s_dbSid>.ora and <s_dbSid>_APPS_BASE.ora files.
    4. Diff the pfile <pfile_name> with the init<s_dbSid>.ora and the <s_dbSid>_APPS_BASE.ora files to view the customizations done in the spfile.
    5. If the values of any of the parameters defined in the init<s_dbSid>.ora or <s_dbSid>_APPS_BASE.ora file have been customized in the spfile, update those values in the corresponding .ora files.
    6. If any new parameters have been introduced in the spfile, add entries for those parameters into the ifile. The location of the ifile is specified by the context variable 's_init_ifile'.
    7. In order to create a new spfile with the latest AutoConfig changes, move the existing spfile to some other location.
    8. Shutdown the database and start it again.
    9. Connect to the database and create the new spfile using the following command:
      SQL>create spfile from pfile;
      This will create the spfile containing the latest AutoConfig changes as well as the existing customizations.
    10. Shutdown the database and start it again for the new spfile location to be reflected in the Database.
  • Case 2: To sync up the spfile with the existing init.ora files

    Perform steps 1 through 10 as mentioned in Case 1, skipping steps 2 and 3 for generation of new init.ora files.
Back to FAQ List

9.9. Windows Specific Requirements

1) What is the correct setting for MSDEVDIR? 

Answer:
Use the path to the VC directory from your Visual Studio 2005 installation. The vcvars32.bat file exists under the VC\bin directory.
For example: MSDEVDIR = C:\VS2005\VC where vcvars32.bat exists under C:\VS2005\VC\bin
Back to FAQ List

2) Can I use the perl shipped by MKS to run adconfig.cmd on Windows?

Answer:
No. The perl shipped by MKS is not certified. Use the perl available in your Applications environment (AS for the application tier, 10g for the database tier) or download ActivePerl from perl.com. Perl has to be in the PATH in order for AutoConfig to run.Back to FAQ List

9.10. Troubleshooting

1) What should I do if my AutoConfig script exits with non-zero status?

Answer:
If AutoConfig exits with non-zero status, open the adconfig.log and check for the reported errors:
  • Errors in the instantiation phase: Check to see if the template files listed in the error summary exist in your file system. If they do not exist, there may be a problem with the AutoConfig file driver of the product. Report the problem to Oracle Support. If the template files exist, check for permission issues. If you cannot fix the issue, report the problem to Oracle Support.
  • Error encountered in the SETUP/PROFILE/APPLY phase: Check the adconfig.log file to see the reason for the failure. If you cannot fix the issue, report the problem to Oracle Support.
Note: Refer to the question "Where are the log files that AutoConfig creates?" for the location of the log file.
Back to FAQ List

APPENDIX A: SPECIFICATION FOR AUTOCONFIG DRIVER FILE SYNTAX

The content for AutoConfig driver files is well defined. Every file you want AutoConfig to instantiate needs an entry in the AutoConfig driver file. Entries consist of <TAB> or <SPACE> separated fields. The following table lists the fields and their contents.
Field NameDescription
Product NameSpecifies the short name for the product
AutoConfig template directoryDirectory underneath the product top that hosts the AutoConfig template file
AutoConfig template fileName of the template file to be processed by AutoConfig
ActionAction that AutoConfig performs on the AutoConfig template file. Possible values are:
  • INSTE8 > AutoConfig instantiates the template each time it is run.
  • INSTE8_SETUP > In addition to instantiating, execute the resulting configuration file during the SETUP Phase of each run of AutoConfig.
  • INSTE8_PRF > In addition to instantiating, execute the resulting configuration file during the PROFILE Phase of each run of AutoConfig.
  • INSTE8_APPLY > In addition to instantiating, execute the resulting configuration file during the APPLY Phase of each run of AutoConfig.
  • INSTALL > AutoConfig instantiates the template file only if the resulting configuration file does not already exist.
  • INSTALL_SETUP > In addition to instantiating, AutoConfig executes the resulting configuration file during the SETUP phase if the configuration file does not already exist.
  • INSTALL_PRF > In addition to instantiating, AutoConfig executes the resulting configuration file during the PROFILE phase if the configuration file does not already exist.
  • INSTALL_APPLY > In addition to instantiating, AutoConfig executes the resulting configuration file during the APPLY phase if the configuration file does not already exist.
Configuration directoryAutoConfig places the instantiated configuration file in this directory
Configuration fileName of the instantiated configuration file
Configuration file permission (UNIX only)AutoConfig generates the configuration file with the provided UNIX-style permissions
For example, in the case of the driver file entry:
my admin/template myTemplate.txt INSTE8 <s_pt> myConfiguration.txt 660
AutoConfig would instantiate the template file <MY_TOP>/admin/template/myTemplate.txt and generate the configuration file myConfiguration.txt into the Portal directory (the Portal directory is instantiated from <s_pt>) with 660 (read and write for user and group) permission. No supplementary information is available at present.

APPENDIX B: SETTING THE PERL5LIB ENVIRONMENT VARIABLE ON THE DATABASE TIER

By default, the PERL5LIB environment variable is set to the following on the Database tier:
<ORACLE_HOME>/perl/lib/5.8.3:<ORACLE_HOME>/perl/lib/site_perl/5.8.3:<ORACLE_HOME>/appsutil/perl
But for an 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 to the following value:
export PERL5LIB=<ORACLE_HOME>/perl/lib/5.10.0:<ORACLE_HOME>/perl/lib/site_perl/5.10.0:<ORACLE_HOME>/appsutil/perl
For an instance with 12c Database, the perl version on the Database tier is '5.14.1'. So the variable 'PERL5LIB' on the 12c database tier needs to be set to the following value:
export PERL5LIB=<ORACLE_HOME>/perl/lib/5.14.1:<ORACLE_HOME>/perl/lib/site_perl/5.14.1:<ORACLE_HOME>/appsutil/perl
The value of PERL5LIB can be updated in the Database tier context file as follows:
  1. Source the Database tier environment file.
  2. Set the value of the environment variable 'PERL5LIB' as recommended above.
  3. Run AutoConfig on the Database tier using adconfig.pl script as follows:
    perl <ORACLE_HOME>/appsutil/bin/adconfig.pl contextfile=<CONTEXT_FILE>
This will set the value of the context variable s_perl5lib in the Database tier context file and update the PERL5LIB value in the Database tier environment file as well.

CHANGE LOG

DateDescription
Aug 03, 2018Updated the patchset number for the latest TXK Delta (R12.TXK.B.DELTA.4 - Patch 27135427).
May 23, 2014Added reference to One-Off Patch 12428418.
Apr 29, 2014Added detailed steps in Appendix B for setting PERL5LIB variable. Added the value to be set for 12c database.
Sep 12, 2012Added reference to One-off Patch 13742583.
June 01, 2011Modified Appendix B with correct value of PERL5LIB variable on the database tier.
July 15, 2010Added reference to the R12.TXK.B.DELTA.3 (Patchset 8919489).
Jun 10, 2010Added reference to the R12.TXK.A.DELTA.7 (Patchset 9386653).
Feb 17, 2010Added reference to the R12.TXK.B.DELTA.2 (Patchset 7651166).
Dec 31, 2009Added appendix regarding setting the PERL5LIB variable on the database tier.
Nov 04, 2009Added information about the new CheckConfig section.
Oct 19, 2009Enhanced Section 3.2 to have a step for running AutoConfig on a newly created Oracle Home.
Sep 10, 2009Modified Section 3.2 Step 3 to clarify the minimum supported jre version.
Aug 28, 2009Added note about TXK AutoConfig Template patch not being released for 12.1.1 as of now.
May 14, 2009Corrected typos in Section 2
Apr 30, 2009Restructured the doc
  • Enhanced the Table of Contents
  • Restructured and split Section 2 (System Configuration and Maintenance) into Sections 2 and 3.
  • Moved the System Configuration commands into Section 7.
  • Moved the AutoConfig tools list into Section 1.
  • Merged the content of Section 6 (AutoConfig on Database tier) into the new section on Patching AutoConfig (Section 3).
  • Renamed Section 3 (Application Services Management) and moved it to Section 7.
Apr 09, 2009Added a new section for the AutoConfig features and tools.
Mar 20, 2008Added a clarification note regarding OCM service management
Dec 23, 2008Updated links to the AutoConfig patch to point to 12.0.6 (R12.TXK.A.DELTA.6) patchset.
Nov 19, 2008Removed links to 12.0.2 (R12.TXK.A.delta.2) patchset.
July 17, 2008Moved the FAQ on spfiles to a generic section.
June 19, 2008Added Section 6, "AutoConfig on the Database tier".
Jan 21, 2008Updated references to the latest AutoConfig Patch.
Dec 11, 2007Added a known issue for Windows Itanium customers.
Nov 06, 2007Added FAQ regarding RAC spfiles.
Oct 18, 2007Updated references to the latest AutoConfig Patch.
Oct 03, 2007Modified instructions for setting default value of custom product top.
July 20, 2007Added a known issue.
July 19, 2007Added back references to the latest AutoConfig Patch.
May 15, 2007Removed references to the latest AutoConfig patch until next patch release.
Feb 19, 2007Modified the name of the custom context variable. Also modified the FAQ on retrieval of context file.
Jan 24, 2007Initial creation.
Note 387859.1 by Oracle E-Business Suite Development
Copyright © 2007, 2008 Oracle Corporation

REFERENCES




Didn't find what you are looking for?
 

Attachments

 

No comments:

Post a Comment

Database Options/Management Packs Usage Reporting for Oracle Databases 11.2 and later (Doc ID 1317265.1)

  Database Options/Management Packs Usage Report You can determine whether an option is currently in use in a database by running options_pa...