using autoconfig to manage system configurations in oracle e-business suite release 12 [id 387859.1]

6/4/13 Document

https://support.oracle.com/epmos/faces/ui/km/DocumentDisplay.jspx?_adf.ctrl-state=dr1guohzo_660 1/41

Using AutoConfig to Manage System Configurations in Oracle E-Business Suite Release 12 [ID387859.1]

Modified: Apr 21, 2013 Type: WHITE PAPER Status: PUBLISHED Priority: 3

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

Last Updated: September 12, 2012

The most current version of this document is published as My Oracle Support Knowledge Document 387859.1.

This document contains the following sections:

Section 1: Overview of AutoConfig Components andTools

1.1. AutoConfig Components1.2. AutoConfig Tools

Section 2: Using AutoConfig Tools for SystemConfiguration

2.1. Previewing Effects of Running AutoConfig2.2. Running AutoConfig on the Database Tier2.3. Running AutoConfig on the ApplicationTier2.4. Reviewing AutoConfig Log Files2.5. Rolling Back an AutoConfig Session

Section 3: Patching AutoConfig

3.1. Applying the Latest AutoConfig Updates3.2. Enabling AutoConfig on a New OracleHome

Section 4: Customizing AutoConfig-ManagedConfigurations

4.1. Prerequisites for AutoConfigCustomizations4.2. Implementing AutoConfig Customizations4.3. Advanced Features of AutoConfigCustomizations

Section 5: Advanced AutoConfig Features and Utilities

5.1. Running AutoConfig in Parallel AcrossMultiple Nodes5.2. Profiling An AutoConfig Run5.3. Using the Check Config Utility5.4. Using the Context Variable InformationUtility

Section 6: Using AutoConfig on an Oracle RACInstance

Section 7: Oracle E-Business Suite Services: ProcessManagement

7.1. Modifying AutoConfig-managed Servicesand Service Groups7.2. Commands to Manage Oracle E-BusinessSuite Service Processes

Section 8: Known Issues

Section 9: Frequently Asked Questions

9.1. Overview and Terminology9.2. The Context File9.3. Running AutoConfig9.4. Customizations9.5. Patching AutoConfig9.6. Net Services9.7. Database Connectivity9.8. Oracle RAC9.9. Windows Specific Requirements9.10. Troubleshooting

Appendix A: Specification for AutoConfig Driver FileSyntax

Appendix B: Setting the PERL5LIB environmentvariable on the Database tier

Change Log

Conventions

6/4/13 Document


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

Convention Meaning

APPLMGR User who owns the Applications file system (APPL_TOP and application tier technology stack)

ORACLE User who owns the database file system (RDBMS ORACLE_HOME and database files).

CONTEXT_NAME Logical name for your Context. Default: _

CONTEXT Full path to the context file (either Applications context file or database context file). Default: /appl/admin/.xml and/appsutil/.xml

APPSpwd Applications database user password

APPSuser/APPSpwd Applications database user name and password

Monospace Text Represents command line text. Type this command exactly as shown.

\ On UNIX, the backslash character is entered at the end of a command line to indicatecontinuation of the command on the next line.

AutoConfig templatefile An AutoConfig template file contains named tags, which are replaced with instance-specific

information when AutoConfig runs. For example:/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 acustom template file and edit the custom template file. For example: /admin/template/custom/afwebprf.sh

When AutoConfig detects a custom template file, AutoConfig instantiates this file in place ofthe AutoConfig template file.

AutoConfig templatedirectory Directory where Oracle delivers AutoConfig template files. There is an AutoConfig template

directory for every product.Location: /admin/template /appsutil/templateFor example: /admin/template /appsutil/template

Custom templatedirectory Directory where you keep your customized AutoConfig template files.

Location: /admin/template/custom /appsutil/template/customFor example: /admin/template/custom /appsutil/template/custom

Configuration file The instantiated configuration file that is created when AutoConfig runs. For example:/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.

6/4/13 Document


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 theinformation required for configuring an Applications instance is collected into two local repositories, called theApplications context file and the database context file. When AutoConfig runs on the application tier, it uses informationfrom the Applications context file to generate all configuration files and update database profiles. When AutoConfigruns on the database tier, it uses information from the database context file to generate all configuration files used onthe database tier.

AutoConfig provides several major benefits, including:

Configuration Support: AutoConfig configures the APPL_TOP, the ORACLE_HOMEs, and the supportingtechnology stack.Configuration Management: AutoConfig centralizes the configuration and re-configuration of an Applicationsinstance.Configuration Delivery and Patching: The uptake of new technology is simplified, as new configurations andconfiguration changes can be provided in the form of a patch.

1.1. AutoConfig Components

AutoConfig consists of several components:

Component Description

Applications context An XML repository located in the INST_TOP that contains information specificto the APPL_TOP.

Database context An XML repository located in the RDBMS ORACLE_HOME that containsinformation specific to that database tier.

AutoConfig template files Files containing named tags that are replaced with instance-specificinformation from the appropriate context ("instantiation").

AutoConfig driver files Every Oracle E-Business Suite product maintains a driver file used byAutoConfig. The driver file lists the AutoConfig file templates and theirdestination locations.

AutoConfig scripts A 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 filestored in the INST_TOP as /appl/admin/.xml. The ApplicationsRelease 12 database tier created via Rapid Install is also AutoConfig-enabled, and has a databasecontext file stored in the RDBMS ORACLE_HOME as /appsutil/.xml. When a change is made to any of the contextfiles 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.

Script LocationUtility

adautocfg.sh/cmd On Applications Tier:/admin/scripts

This script isused for running

6/4/13 Document


On Database Tier:/appsutil/scripts/

AutoConfig.

More Details

adchkcfg.sh/cmd On Applications Tier:/bin

On Database Tier:/appsutil/bin

This script maybe run beforerunningAutoConfig toreview thechanges onrunningAutoConfig. Thiswill generate areport showingthe differencesbetween theexistingconfigurationand what theconfigurationwould be afterrunningAutoConfig.

More Details

GenCtxInfRep.pl On Applications Tier:

6/4/13 Document


applying patchesto the databasetier. Running thisscript generatesappsutil.zipwhich may becopied over tothe database tierto migrate thepatch to thedatabase tier.

More Details

Besides the above tools, there are start and stop tools that are used to manage the run-time processesof 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 theAutoConfig 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 filesystem 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 /appsutil/bin/adchkcfg.sh contextfile=

On Windows:

\appsutil\bin\adchkcfg.cmd contextfile=

On the Applications tier:On Unix:

sh /bin/adchkcfg.sh contextfile=

On Windows:

\bin\adchkcfg.cmd contextfile=

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

6/4/13 Document


After customizations on the database tierAfter a database or application tier upgradeAfter restoration of the database or Oracle Home from a backup tapeAfter a JDK upgrade on the database tierAfter 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 /appsutil/scripts//adautocfg.sh

On Windows:

\appsutil\scripts\\adautocfg.cmd

Attention:

The database server and the database listener must remain available during the AutoConfigrun. All the other database tier services should be shut down.Running AutoConfig may change your existing environment files. After running AutoConfig, youshould always set the environment before you run any Applications utilities, in order to applythe 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 /admin/scripts/adautocfg.sh

On Windows:

\admin\scripts\adautocfg.cmd

Attention:

The database server and the database listener must remain available during the AutoConfigrun. Only the application tier servers should be shut down. Running AutoConfig may change your existing environment files. After running AutoConfig, youshould always set the environment before you run any Applications utilities, in order to applythe changed environment variables.

6/4/13 Document


2.4. Reviewing AutoConfig Log Files

AutoConfig logfiles are stored under:

Tier Directory

Application /admin/log/

Database /appsutil/log//

One log file is created per AutoConfig session. It will contain details of every action that AutoConfig performed duringthe 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 ifnecessary. The script and all backup configuration files from each AutoConfig session are stored in:

Tier Directory

Application /admin/out/

Database /appsutil/out//

where: = (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 applicationstier 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 followingsteps in the order listed:

a. Apply the TXK AutoConfig Template patchUpdate the Oracle Applications file system with the AutoConfig files by applying the latest AutoConfig Templatepatch (Patch 9386653 for 12.0.X customers and Patch 8919489 for 12.1.X customers) to all application tiernodes in the Applications instance.

Windows Itanium customers on 12.0.X should apply an additional one-off patch, 6501658. Customers need tobe 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 theadditional one-off Patch 13742583.

6/4/13 Document


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

b. 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 /bin/admkappsutil.pl

This will create appsutil.zip in /admin/out

On the database tier (as the ORACLE user):Copy or FTP the appsutil.zip file to the

cd

unzip -o appsutil.zip

c. Run AutoConfig Run AutoConfig on the database tier and then on the applications tier as described in sub-sections 2.2 and 2.3 inSection 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 thefollowing scenarios:

Database tier not created by Rapid InstallCross platform migration of the database tierUpgrading to 11g DatabaseUpgrading 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 thecontext file on the database tier. This patch is also included in the latest AutoConfig Template patch (Patch9386653 for 12.0.X customers and Patch 8919489 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 tobe 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 patchfollowing Step 2 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 orhigher:

If you are using a "fully certified" platform, please refer to Metalink Note 418664.1 to install jre under the/appsutil directory.

If you are using a "Database tier only" platform, please refer to Metalink Note 456197.1 to install jre

6/4/13 Document


under the /appsutil directory.

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

perl /appsutil/bin/adbldxml.pl

Attention: If you build the context file for an instance that runs on RAC, all your RAC instances have to beup and running while executing the adbldxml utility. The utility connects to all RAC instances to gatherinformation about the configuration.

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

On Unix:

/appsutil/bin/adconfig.sh contextfile=

On Windows:

\appsutil\bin\adconfig.cmd contextfile=

Section 4: Customizing AutoConfig-Managed Configurations

AutoConfig is a tool that simplifies and standardizes configuration management tasks in an Oracle E-Business Suiteenvironment. The configuration generated by AutoConfig may not always meet your specific requirements, and it maybe 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 servicesDefine your OC4J configurationExtend Oracle Forms to integrate with a third party Java versionDevelop custom applications that are maintained by AutoConfig

Historically, Oracle did not document procedures on how to implement customizations. If you tried to customize yourAutoConfig-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 theconfiguration files. This limited and inflexible method has now been superseded by a fully supported mechanism toextend your AutoConfig-maintained environment with maximum flexibility, and preserving your extensions every timeAutoConfig 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 identifythe manual configuration changes that you want to implement as customizations.

2. Review and migrate existing customizations

6/4/13 Document


If you implemented customizations between "Begin/End customization" blocks in the past, then you mustmigrate those settings now. Execute the following command:

Platform Tier Command

UNIX Application /bin/adcustomizer.sh contextfile=

Database /appsutil/bin/adcustomizer.sh contextfile=

Windows Application \bin\adcustomizer.cmd contextfile=

Database \appsutil\bin\adcustomizer.cmd contextfile=

The adcustomizer script:

a. Detects all configuration files that have "Begin/End customizations" blocks.b. Copies the corresponding AutoConfig template files to custom template files.c. Appends the contents in the "Begin/End customizations" blocks to the end of the custom template files.d. Removes the "Begin/End customizations" blocks from the configuration file.

Review the logfile generated by the adcustomizer script. Ensure that all your customizations were successfullymigrated 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 ofcustomizations:

Changing the value of an existing context variableAdding a new context variable to the context fileCustomizing an AutoConfig template file delivered by OracleCreating a customer owned AutoConfig template file

1. Changing the value of an existing context variable

a. Edit the context variable value

Use the Oracle Applications Manager Context Editor to change values of existing context variables. Referto Oracle Applications System Administrator's Guide - Configuration for details of how to use the OracleApplications Manager Context Editor.

6/4/13 Document


b. Run AutoConfig

Depending on whether the context variable belongs to the application tier or the database tier, runAutoConfig on the appropriate tier, following the steps mentioned in Section 2.

2. Adding a new context variable to the context file

a. Add the context variable

Use the Oracle Applications Manager Context Editor if you want to add a context variable that is notmaintained by AutoConfig. Refer to the Help pages available on Oracle Applications Manager. Therelevant information for adding custom context variables is located in the "System Configuration" >"AutoConfig" > "Manage Custom Parameters" section.

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

3. 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:

a. Determine the AutoConfig template file you want to customize

Execute the following command to find out the corresponding AutoConfig template file for theconfiguration file you want to customize:

Platform Tier Command

UNIX Application /bin/adtmplreport.sh contextfile=target=

Database /appsutil/bin/adtmplreport.shcontextfile= target=

Windows Application \bin\adtmplreport.cmd contextfile=target=

Database \appsutil\bin\adtmplreport.cmdcontextfile= target=

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

6/4/13 Document


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 ifthe "LOCK" keyword appears in the template file's entry in the product driver file. AutoConfig ignorescustom template files that are marked with "LOCK".

For example, the following entry in /admin/driver/adtmpl.drv would preventcustomization of the file adconfig.txt:

ad admin/template adconfig.txt INSTE8 /admin adconfig.txt 600 LOCK

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

For example, if you want to customize /admin/template/afwebprf.sh, execute thefollowing command as the applmgr user:

On UNIX

mkdir $FND_TOP/admin/template/custom

On Windows

mkdir %FND_TOP%\admin\template\custom

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

For example:

cp -i $FND_TOP/admin/template/afwebprf.sh \

$FND_TOP/admin/template/custom/afwebprf.sh

On Windows

copy

For example:

copy %FND_TOP%\admin\template\afwebprf.cmd \

%FND_TOP%\admin\template\custom\afwebprf.cmd

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

6/4/13 Document


Windows.

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

e. Verify your customizationsExecute the adchkcfg utility as described in Section 5.3. When this utility runs, it instantiates any customtemplate files in place of the corresponding AutoConfig template file. The adchkcfg utility generates areport with information about all files and profile options that will be changed during the next normal runof 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: /admin/out/

On the database tier: /appsutil/out//

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

4. Creating a customer-owned AutoConfig template file

You can create an AutoConfig template file of your own. This will enable you to develop customapplications that AutoConfig can configure and maintain.

Perform the following tasks in the order listed:

a. Define a product_topUse 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 addingcustom context variables is located in the "System Configuration"> "AutoConfig"> "Manage CustomParameters" section. Choose the variable type "PROD_TOP" when adding the product_top variable. Thedefault value for the product_top variable must be set to '//12.0.0'.

For example, define the product top for the product 'my' as follows:

OA_VAR = c_mytop

Default Value = /my/12.0.0

Title = My Product top

Description = This is my product top

OA_TYPE = PROD_TOP

b. Create the customer-owned AutoConfig template directoryCreate the directory where your AutoConfig template files will reside. Execute the following command asthe applmgr user:

On UNIX

mkdir /admin/template

6/4/13 Document


On Windows

mkdir \admin\template

c. Develop the customer-owned AutoConfig template fileCreate 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 contextvariables in the file. When AutoConfig runs, it replaces the context variables with the associated valuesfrom the context file.

For example, create and edit the file

/admin/template/myTemplate.txt

d. Create the customer-owned AutoConfig driver directoryCreate the directory where your AutoConfig driver file will reside. Execute the following command as theapplmgr user:

On UNIX

mkdir /admin/driver

On Windows

mkdir \admin\driver

e. Develop the customer-owned AutoConfig driver fileThe AutoConfig driver file instructs AutoConfig where to place the generated configuration file. Place thedriver file in the custom AutoConfig driver directory. The name for the driver file is defined as:tmpl.drv. In this example, the driver file would be named: mytmpl.drv. Refer toAppendix A: Specification for AutoConfig Driver File Syntax for information on the format of the driverfile.

For example, to have AutoConfig instantiate the above example template file, the driver file would needto contain this line:

my admin/template myTemplate.txt INSTE8 myConfiguration.txt 660

4.3. Advanced Features of AutoConfig Customizations

This section discusses advanced features when using AutoConfig Customizations.

1. Debugging customizationsIf problems arise with customizations that you implemented, it may be useful to run AutoConfig with theAutoConfig template files, ignoring any custom template files. Execute the following command:

On UNIX

/bin/adconfig.sh -nocustom contextfile=

On Windows

\bin\adconfig.cmd -nocustom contextfile=

2. Preserving customizations after updates

6/4/13 Document


You must review your customizations whenever AD Patch delivers a new version of an AutoConfig template filefor which you edited the corresponding custom template file. If the customizations are still required, copy thenew 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. ReportsThe report produced by the adtmplreport utility can:

List all customized files in an Oracle E-Business Suite instanceList all AutoConfig template files, their custom template files and their configuration filesIdentify the name and location of the AutoConfig template file and the custom template file for a givenconfiguration fileIdentify the name and location of the configuration file for a given AutoConfig template file

The report utility is located at:

Tier Location

Application /bin

Database /appsutil/bin

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

Platform Command

UNIX adtmplreport.sh contextfile= listcustom

Windows adtmplreport.cmd contextfile= listcustom

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

Platform Command

UNIX adtmplreport.sh contextfile=

Windows adtmplreport.cmd contextfile=

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

Platform Command

UNIX adtmplreport.sh contextfile= template=

Windows adtmplreport.cmd contextfile= template=

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

Platform Command

UNIX adtmplreport.sh contextfile= target=

6/4/13 Document


Windows adtmplreport.cmd contextfile= target=

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 simultaneouslyacross 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 /bin/adconfig.pl contextfile= [product=] parallel

On Database tier:

perl /appsutil/bin/adconfig.pl contextfile= parallel

Note: When running AutoConfig simultaneously on multiple nodes, the '-parallel' option must be specified whilestarting AutoConfig on every node. Otherwise the execution of AutoConfig processes on individual nodes will notbe 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 canbe used to profile an AutoConfig run and generate a consolidated report in HTML format. The report displays asummarized view listing all the product tops along with the total instantiation/execution time of the templates withinthem. The profile report comprises the following sections:

Summary (See a screen shot)This section of the report shows the profile information for all product tops processed in the current AutoConfigrun. 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 eachproduct top.Status: Whether or not all the templates from each product top were successfully instantiated andexecuted.

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

Details (See a screen shot)This section contains the profile information for all product templates that are only instantiated/executed in thecurrent 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.

6/4/13 Document


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 ofthe 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 /bin/adconfig.pl contextfile= [product=] profile

On Database Tier:

perl /appsutil/bin/adconfig.pl contextfile= [product=] 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. Itis used to review the configuration changes that would take effect on an E-Business Suite instance during the nextAutoConfig run. It identifies the potential changes to both the File system as well as the Database. It can be run onboth the applications tier and the database tier.

The utility is located in the following location:

Tier Location

Application /bin

Database /appsutil/bin

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

On UNIX

adchkcfg.sh contextfile=

On Windows

adchkcfg.cmd contextfile=

This script generates both HTML and text reports. The reports provide information about all file changes, profile optionchanges and other important database updates that will be done during the next normal execution of AutoConfig. Thereport consists of two tabs:

File System Changes (See a screen shot)This report is divided into the following sections:

AutoConfig Context File ChangesDisplays 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 alsodisplays 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. Thissection is present only in the report generated on the applications tier. Changed Configuration FilesDisplays 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, thecontent of the file that will be generated in the next AutoConfig run. In addition, an HTML report

6/4/13 Document


highlights the differences between the current and the new configuration file, plus the location of theAutoConfig template file (if applicable).New Configuration FilesDisplays 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 locationof the AutoConfig template file.Template CustomizationsThis section has been introduced in Oracle Techstack Release Update Pack 2 for 12.1. It displays a list ofall customized AutoConfig templates and reports the diff between the original AutoConfig template andthe customized template.

Database Changes (See a screen shot)This report is divided into the following sections:

Profile Value ChangesDisplays details of only those profiles whose value would be changed in the next AutoConfig run. Foreach 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 ValuesDisplays details as in previous section for all Apps Database profiles managed by AutoConfig, irrespectiveof whether their value would change or not in the next AutoConfig run.Other Database updatesDisplays details for important database updates (non-profile changes) that will be done in the next run ofAutoConfig. The table name, column name, the current column value in the Database and the newAutoConfig value is displayed along with the name of the updating AutoConfig script and a briefdescription.

The script also creates a zip file report "ADXcfgcheck.zip" that contains all the files and reports mentioned above. TheADXcfgcheck.zip can be copied to a local desktop PC and the HTML report can be viewed there without breaking thehyper-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 inwhich they are used. The utility accepts all or part of a context variable name and generates an HTML or text reportcontaining information about the matched context variables - the variable descriptions, default and current values. Thevariable description contains recommended settings, range of allowed values and links to documents for detailed usageinformation. Additionally, this utility lists the configuration templates where the respective context variables are used.See a screen shot of the generated report.

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 /bin/txkrun.pl -script=GenCtxInfRep -keyword=""

On Database Tier:

perl /appsutil/bin/txkrun.pl -script=GenCtxInfRep -keyword=""

The utility takes the following arguments:

6/4/13 Document


contextfile (optional): complete path to the context file. By default, it is set to the value of

keyword (required): all or part of a context variable namereportType (optional): the report type. Valid values are html (default) or textoutfile (required): the report file. If only the name and not the complete path for the report file isprovided, the report will be generated in the 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 runningon Oracle Real Application Clusters (Oracle RAC).

Note: Refer to Oracle MetaLink Note 388577.1 for converting a Release 12 single instance to OracleRAC, implementing AutoConfig with Oracle RAC, and implementing load balancing of databaseconnections 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 forOracle RAC. This includes

Instance aliases for each database tier nodeLoad balance aliases with address lists for each database tier nodeFNDSM and FNDFS aliases (used by the CP Service Manager) for each application tier nodeVirtual hostname support

The tnsnames.ora file is dynamically generated using the Net Services Topology Data Model. The Net ServicesTopology 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 Templatepatch (Patch 9386653 for 12.0.X customers and Patch 8919489 for 12.1.X customers) to all application tiernodes 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 willgenerate an init.ora that is compatible with Oracle RAC. We recommend creating a backup of the existinginit.ora file and let AutoConfig generate a new init.ora file. This will ensure that the init.ora file conforms to theOracle'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 availableduring 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.

6/4/13 Document


Attention: The database server and the database listener must remain available during theAutoConfig 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 systemconfiguration.

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 andadstpall.sh/cmd can be used for this purpose.

In Applications Release 12, the Applications services have been categorized into service groups, according to the typeof service provided. A particular service will be started or stopped via the adstrtal or adstpall scripts only if both theservice 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 ofApplications 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 notneeded.

a. 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 thereport generated by the Check Config utility (adchkcfg). For more details, please refer to Section5.3.

Additionally, the log files generated by the adstrtal/adstpall scripts also provide a report containinga list of the Application service groups and the services that are managed via AutoConfig. This listalso reports whether a particular service group or service is 'enabled' or 'disabled'.

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

c. Enabling a Service

Check the value of the 'status' context variable corresponding to the service group to whichthe 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' ifit is not already set to 'enabled'.

d. Disabling a ServiceCheck 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'.

6/4/13 Document


For example, perform the following steps to manage the service 'Oracle Metrics Server' (part of theService 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, pleaserefer to My Oracle Support Knowledge Document 406558.1.

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

a. Commands for managing processes on the Applications tier

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 servicecontrol scripts.

All scripts listed below are located in /admin/scripts.

Functionality UNIX Command Windows Command

Start Applications services adstrtal.sh adstrtal.cmd

Stop Applications services adstpall.sh adstpall.cmd

Start individual service start

start

Stop individual service stop

stop

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

b. Commands for managing processes on the Database tier

All the scripts listed below are located in /appsutil/scripts/.

Functionality UNIX Command Windows Command

Start database listener process addlnctl.sh start addlnctl.cmd start

Stop database listener process addlnctl.sh stop addlnctl.cmd stop

Start database process addbctl.sh start addbctl.cmd start

Stop database process addbctl.sh stop addbctl.cmd stop

Note: To manage Oracle Configuration Manager (OCM) processes running on an Oracle E-Business Suite Release

6/4/13 Document


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 12environment.

1. On a Multi-node installation with the Forms Services and Batch Processing Services enabled onseparate 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 theservice using one of the following options:

a. Start the TNS listener service manually using the following command:

On UNIX

sh $INST_TOP/admin/scripts/adalnctl.sh start

On Windows

%INST_TOP%\admin\scripts\adalnctl.cmd start

a. Enable management of the TNS Listener Service via the adstrtal/adstpall scripts on the Forms Servicesnode.

'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 the12.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 does the term "Config Home" mean?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?

6/4/13 Document


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 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 Ideregister the tier?

12. I want to purge the complete Net Services Topology Data Model. I can't use the adgentns.pl script because Iremoved 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

6/4/13 Document


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. Theinformation required for configuring an Applications system is collected into an XML repository, called the Applicationscontext. There is one Applications context for each application tier, and one for each database tier. When AutoConfigruns, it uses information from the Applications context file to generate all configuration files, and update databaseprofiles.

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:

A server is the traditional term for a process that provides a particular functionality. This term, in the sense of adenoting a single process, is less appropriate for some components of the Release 12 architecture, in whichcase the replacement term of service or service group is used.A node is a logical grouping of servers, and therefore fundamentally a software concept rather than a hardwareconcept, although it is often also used to refer to the machine on which a particular node is installed.A 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 definethe set of processes that will be started on each application node, and can be activated or deactivated accordingto the function the node is to perform. These include Forms services, Web services, and Batch Processingservices (Concurrent Processing server). A key role of these services is to provide communication between thedesktop tier and the database tier.The database tier consists of the database server, which stores all the data of the Release 12 system in anOracle database.

The primary location of the files used by the application tier servers is the APPL_TOP, whereas the primary location ofthe files used by the database tier server is the Oracle10g ORACLE_HOME.

Back to FAQ List

6/4/13 Document


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 arecontained 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 thenode 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 isconsidered an application tier server node. If the node contains the database server, which means that there is anOracle10g ORACLE_HOME and the Applications database instance on the node, then the node belongs to the databasetier, and is considered a database server node.

Let's analyze a common configuration where the database server and the Concurrent Processing server exist on onenode (Node 1), and the other servers exist on a second node (Node 2). Since Node 1 contains both an application tierserver (Concurrent Processing server) and the database server, Node 1 belongs to both the database tier and theapplication 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 databaseserver, 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 thatowns 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 andthe oracle user can be the same user, or different users.

Back to FAQ List

6) What does the term "" mean?

Answer:The "" is the logical name for your context repository. The default value for is_.

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. Thelocation is pointed to by the context variable s_config_home.

6/4/13 Document


Back to FAQ List

8) What are the basic components of AutoConfig?

Answer:

Components Location Description

ApplicationsContext

On the application tier: /appl/admin

On the database tier: /appsutil

An XML repository(.xml) containsinformation specific to that Applicationsinstance. Do not manually update this file!

AutoConfigTemplate Files On the application tier:

/admin/template

For example: /admin/template /admin/template

On the database tier: /appsutil/template

Include named tags which are replaced withinstance-specific information from theApplications Context. There is one templatefile for each configuration file.

For example: apps_nt.conf apps_ux.conf

AutoConfig DriverFile

On the application tier: /admin/driver

For example: /admin/driver/adtmpl.drv /admin/driver/fndtmpl.drv

On the database tier: /appsutil/template

Used by AutoConfig to list the AutoConfigTemplate Files, their destination locations,and the commands to be executed, forexample, the commands to update profileoptions. Every Product Top contains its ownAutoConfig Driver File.

AutoConfig Scripts On the application tier: /bin

On the database tier: /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.

6/4/13 Document


Scripts Location Description

adautocfg.sh

adautocfg.cmd

On the application tier: /admin/scripts

On the database tier: /appsutil/scripts/

A wrapper script that callsadconfig.sh/adconfig.cmd. Instantiatestemplate files with values specific to the instance(taken from the Applications for the application tierand the database context for the database tier).Updates configuration files and profile options.

adconfig.sh

adconfig.cmd

On the application tier: /bin

On the database tier: /appsutil/bin/

A wrapper script that calls adconfig.pl. In earlierversions of AutoConfig adconfig.sh/adconfig.cmd used to call the Java API to startAutoConfig.

adconfig.pl On the application tier: /bin


A wrapper script that calls the Java API to startAutoConfig.

adchkcfg.sh

adchkcfg.cmd

On the application tier: /bin


Generates a report that highlights differencesbetween the original config files and AutoConfig-generated config files. The report is namedcfgcheck.html. It is located under:

On the application tier: /admin//out/

On the database tier: /appsutil/out/

/

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

Back to FAQ List

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

Answer:

6/4/13 Document


In Oracle Applications Manager (OAM), navigate to Site Map. Click on AutoConfig. Click on Edit Parameters to edit therelevant context file.

Attention: Manually editing a context file is not supported. Many context variables havedependencies between each other. The OAM AutoConfig resolves all these dependencieswhen changing the value of a variable. Manually editing the context file could bring thedata 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 whenmigrating AutoConfig to a database tier not created using Rapid Install or when upgrading a database tier fromApplications 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 /clone/bin/adclonectx.pl retrieve

On being prompted for the context file to be retrieved, select the option of retrieving the applications tier contextfile that has been lost and retrieve it to the default location specified by the script.

The above command can be used only when the is still intact. In case the has also beenlost accidentally, the applications tier context file may be retrieved as follows:

Execute the following command on the database tier:

perl /appsutil/clone/bin/adclonectx.pl retrieve

On being prompted for the context file to be retrieved, select the option of retrieving the applications tier contextfile 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 thecontext file in the context variable 's_contextfile'.

To retrieve the database tier context file,

Execute the following command on the database tier:

perl /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

6/4/13 Document


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).An OracleMetaLink note instructs you to run AutoConfig as part of an upgrade, migration, cloning and/orconfiguration 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 runAutoConfig.

For instructions on how to run the adchkcfg utility and a discussion about the report that the utility generates, refer toSection 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:/admin/log//adconfig.log

On the database tier:/appsutil/log///adconfig.log

where: = (month, day, hour, and minute of the AutoConfig run)

Back to FAQ List

4) Which directories based on the will AutoConfig create?

Answer: AutoConfig creates the following directories based on the :

Instance Top : /inst/apps/

Back to FAQ List

6/4/13 Document


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 /admin/scripts. This location isalso 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: /admin/out/

On the database tier: /appsutil/out//

where: = (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 notrecognized 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-customizabletemplate. If the "LOCK" keyword is not seen, then that template can be customized.

6/4/13 Document


For example:

fnd admin/template apps_conf_1013.tmp INSTE8 /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. InRelease 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 AutoConfigtemplate.

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 aswell as for AutoConfig. Patch 9386653 delivers the latest TXK product patches for 12.0.X. Patch 8919489 contains thelatest 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 8919489 for12.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 Suiteinstance. The data model stores information about each node in the Oracle E-Business Suite instance, which is then

6/4/13 Document


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 DescriptorsApplication 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. Everytime you run AutoConfig on the database tier, the relevant data is seeded for the database tier. Every time you runAutoConfig 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 tosupport 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 applicationtier. 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 tierYour database is upgraded/migrated resulting in a change in one of the following parameters:

Database HostDatabase PortDatabase NameDatabase 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:

6/4/13 Document


perl /bin/adgentns.pl contextfile= -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 /appsutil/bin/adgentns.pl contextfile= -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 ofa 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 /bin/adgentns.pl contextfile= -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'tuse the adgentns.pl script because I already decommissioned the tier or removed the context file. How can Ideregister 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 nameObtain it by running the following SQL query:

select DB_NAME from FND_DATABASES;

2. Locate the server name corresponding to the tier in question:

Run this SQL query on the database tier:

6/4/13 Document


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');

3. 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 Iremoved 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 nameObtain 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. Forexample:

6/4/13 Document


'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 isnot 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 rulesas described above

2. Run AutoConfig on all database tiers3. Run AutoConfig on all application tiers

These steps will generate the failover TNS alias _FO with a description list as configured ins_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 offailover aliases on different database versions.

Note: The generated alias _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 Release12 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 databasetier 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 contextvariable 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_dbportcontext 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:

6/4/13 Document


You should reset the value for s_apps_jdbc_connect_descriptor to an empty value (" "), when one of the followingvalues changes:

Database HostDatabase 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 onehost/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 anempty string.

2. Update the context variables s_dbhost and s_dbport in the context file for the application tier to reflectthe 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 olddatabase. 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 thecomplete 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 Iachieve that?

Answer:AutoConfig is already enabled by default in your Release 12 instance.

Back to FAQ List

6/4/13 Document


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

Answer:To migrate an Oracle E-Business Suite Release 12 instance to Oracle RAC, follow the instructions described inDocument 388577.1: Using Oracle 10g Release 2 Real Application Clusters and Automatic Storage Management withOracle 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 instancealiases. 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 loadbalanced alias names:

s_tools_twotasks_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.ora: This file contains database parameters specific to RAC configuration.

_APPS_BASE.ora: This file contains generic database parameters that are applicable for bothnon-RAC and RAC configurations.

Any additional database parameter values may be set by specifying them in the ifile. The location of the ifile isspecified 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='' from spfile;

Note: The provided should be different from init.ora. Otherwise, it wouldoverwrite the existing init.ora file generated in the last AutoConfig run.

2. Move the existing init.ora file and _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.ora and _APPS_BASE.ora files.4. Diff the pfile with the init.ora and the _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.ora or _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'.

6/4/13 Document


7. In order to create a new spfile with the latest AutoConfig changes, move the existing spfile to some otherlocation.

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\bindirectory.

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 theapplication tier, 10g for the database tier) or download ActivePerl from perl.com. Perl has to be in the PATH in orderfor 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 yourfile system. If they do not exist, there may be a problem with the AutoConfig file driver of the product. Reportthe problem to Oracle Support. If the template files exist, check for permission issues. If you cannot fix theissue, report the problem to Oracle Support.Error encountered in the SETUP/PROFILE/APPLY phase: Check the adconfig.log file to see the reason forthe 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.

6/4/13 Document


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 inthe AutoConfig driver file. Entries consist of or separated fields. The following table lists the fieldsand their contents.

Field Name Description

Product Name Specifies the short name for the product

AutoConfigtemplatedirectory

Directory underneath the product top that hosts the AutoConfig template file

AutoConfigtemplate file

Name of the template file to be processed by AutoConfig

Action Action 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 duringthe SETUP Phase of each run of AutoConfig.INSTE8_PRF > In addition to instantiating, execute the resulting configuration file during thePROFILE Phase of each run of AutoConfig.INSTE8_APPLY > In addition to instantiating, execute the resulting configuration file duringthe APPLY Phase of each run of AutoConfig.INSTALL > AutoConfig instantiates the template file only if the resulting configuration filedoes not already exist.INSTALL_SETUP > In addition to instantiating, AutoConfig executes the resultingconfiguration file during the SETUP phase if the configuration file does not already exist.INSTALL_PRF > In addition to instantiating, AutoConfig executes the resulting configurationfile during the PROFILE phase if the configuration file does not already exist.INSTALL_APPLY > In addition to instantiating, AutoConfig executes the resultingconfiguration file during the APPLY phase if the configuration file does not already exist.

Configurationdirectory

AutoConfig places the instantiated configuration file in this directory

Configurationfile

Name of the instantiated configuration file

Configurationfile 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

using autoconfig to manage system configurations in oracle e-business suite release 12 [id 387859.1]

Documents