101026152700

7/27/2019 101026152700

1/20

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

Modified 14-OCT-2010 Type WHITE PAPER Status PUBLISHED

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

Last Updated: J uly 15, 2010

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 and Tools

1.1. AutoConfig Components1.2. AutoConfig Tools

Section 2: Using AutoConfig Tools for System Configuration

2.1. Previewing Effects of Running AutoConfig2.2. Running AutoConfig on the Database Tier2.3. Running AutoConfig on the Application Tier2.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 Oracle Home

Section 4: Customizing AutoConfig-Managed Configurations4.1. Prerequisites for AutoConfig Customizations4.2. Implementing AutoConfig Customizations4.3. Advanced Features of AutoConfig Customizations

Section 5: Advanced AutoConfig Features and Utilities

5.1. Running AutoConfig in Parallel Across Multiple Nodes5.2. Profiling An AutoConfig Run5.3. Using the Check Config Utility5.4. Using the Context Variable Information Utility

Section 6: Using AutoConfig on an Oracle RAC Instance

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

7.1. Modifying AutoConfig-managed Services and Service Groups7.2. Commands to Manage Oracle E-Business Suite 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 Services

9.7. Database Connectivity 9.8. Oracle RAC9.9. Windows Specific Requirements9.10. Troubleshooting

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

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 Co ntext. Default: _

CONTEXT Ful l path to t he context f ile (eit her Applicat ions context f ile or database context file).Default: /appl/admin/.xmland /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 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:/admin/template/afwebprf.shAutoConfig 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. Forexample: /admin/template/custom/afwebprf.shWhen 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: /admin/template

/appsutil/templateFor example: /admin/template

/appsutil/template

Custom template directoryDirectory where you keep your customized AutoConfig template files.Location: /admin/template/custom

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

/appsutil/template/custom

Configuration f ile The instantiated configuration f ile that is created when AutoConfig runs. For example:/admin/install/afwebprf.sh

< > Text enclosed in ang le brackets represents a variable. Subst itute a value for the variable text . Do not t ype 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 theApplications context file to generate all configuration files and update database profiles. When AutoConfig runs on the database tier, it uses information from the database contextfile 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.

Page 1 of 20Using AutoConfig to Manage System Configurations with Oracle Applications Releas...

2010/10/25https://support.oracle.com/CSP/main/article?cmd=show&type=NOT&doctype=WHIT...

7/27/2019 101026152700

2/20

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:

Component Description

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

Database context An XML repository located in the RDBMS ORACLE_HOME that contains information specific to that database t ier.

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

AutoConfig driver files Every Oracle E-Business Suite product maintains a driver file used by AutoConfig. 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 file stored in the INST_TOP as/appl/admin/.xml . The Applications Release 12 database tier created via Rapid Install is also AutoConfig-enabled, and has adatabase context file stored in the RDBMS ORACLE_HOME as /appsutil/.xml. When a change is made to any of thecontext 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.

Script LocationUtility

adautocfg.sh/cmd On Applications Tier:

/ admi n/ sc r i pt s

On Database Tier:/ appsut i l / scr i pt s/

This script is used for running AutoConfig.

More Details

adchkcfg.sh/cmd On Applications Tier:/ bi n

On Database Tier:/ apps ut i l / bi n

This script may be run before running AutoConfig to review the changes on runningAutoConfig. This will generate a report showing the differences between the existingconfiguration and what the configuration would be after running AutoConfig.

More Details

GenCtxInfRep.pl On Applications Tier:

7/27/2019 101026152700

3/20

After the Net Services Topology Information is manually cleaned up using one of the supported procedures(eg. f nd_conc_cl one. set up_cl ean). Subsequently, AutoConfigmust 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 / appsut i l / sc r i pt s/ / adaut ocf g. s h

On Windows:

\ appsut i l \ sc r i pt s\ \ adaut ocf g. cmd

Att ention:

The database server and the database listener must remain available during the AutoConfig run. All the other database tier services should be shutdown.

Running AutoConfig may change your existing environment files. After running AutoConfig, you should always set the environment before you run anyApplications 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 / admi n/ scr i pt s/ adaut ocf g. sh

On Windows:

\ admi n\ sc r i pt s\ adaut ocf g. cmd

Att ention:

The database server and the database listener must remain available during the AutoConfig run. Only the application tier servers should be shut down.Running AutoConfig may change your existing environment files. After running AutoConfig, you should always set the environment before you run any

Applications utilities, in order to apply the changed environment variables.

2.4. Reviewing AutoConfig Log Files

AutoConfig logfiles are stored under:

Tier Directory

Application / admi n/ l og/

Database / appsut i l / l og/ /

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 eachAutoConfig session are stored in:

Tier Directory

Application / admi n/ out /

Database / appsut i l / out / /

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

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

On UNIX

rest ore. sh

On Windows

r est or e. 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:

App ly t he TXK Aut oConf ig Temp late 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 Patch8919489 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-offpatch.

a.

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



7/27/2019 101026152700

4/20

Copy Aut oConfig to the RDBMS ORACLE_HOMEUpdate the RDBMS ORACLE_HOME file system with the AutoConfig files by performing the following steps:

b.

On the application tier (as the APPLMGR user):Log in to the APPL_TOP environment (source the environment file)Create appsutil.zip file

per l / bi n/ admkappsut i l . pl

This will create appsutil.zip in /admin/outOn the database tier (as the ORACLE user):

Copy or FTP the appsutil.zip file to the

cd unzi p - o appsut i l . zi p

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

c.

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

App ly 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 thelatest AutoConfig Template patch (Patch 9386653 for 12.0.X customers and Patch 8919489 for 12.1.X customers).

1.

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

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

2.

Install J RE 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:

3.

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 under the /appsutil directory.Generate the Database Context Fi leExecute the following command to create your Database Context File:

4.

per l / appsut i l / bi n/ adbl dxml . pl

Att entio n: 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 utilityconnects to all RAC instances to gather information about the configuration.

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

5.

On Unix:

/ appsut i l / bi n/ adconf i g. s h cont ext f i l e=

On Windows:

\ appsut i l \ bi n\ adconf i g. cmd cont ext f i l e=

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 maynot 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 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 your AutoConfig-generated files by manually editing them, yourchanges 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 to extend your AutoConfig-maintained environment with maximumflexibility, and preserving your extensions every time AutoConfig is run.

4.1. Prerequisites for Aut oConfig Customizations

Before customizing AutoConfig, certain prerequisites must be met.

Review your current configuration1.

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 implementas customizations.

Review and migrate existing customizations2.

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

Platform Tier Command

UNIX Application / bi n/ adcust omi zer . sh cont ext f i l e=



7/27/2019 101026152700

5/20

Database / appsut i l / bi n/ adcus t omi zer . sh cont ext f i l e=

Windows Application \ bi n\ adcus t omi zer . cmd cont ext f i l e=

Database \ appsut i l \ bi n\ adcust omi zer . cmd cont ext f i l e=

The adcustomizer script:

Detects all configuration files that have "Begin/End customizations" blocks.a.Copies the corresponding AutoConfig template files to custom template files.b.

Appends the contents in the "Begin/End customizations" blocks to the end of the custom template files.c.Removes the "Begin/End customizations" blocks from the configuration file.d.

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 Aut oConfig Customizations

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

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

################################################################## This file is automatically generated by AutoConfig. It will be read and# overwritten. If you were instructed to edit this file, or if you are not# able to use the settings created by AutoConfig, refer to Metalink# document 387859.1 for assistance.#################################################################

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

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

Changing the value of an existing context variable1.

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.

a.

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

b.

Add ing a new con text vari able to the co ntext fil e2.

Add t he con text v ariab le

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 CustomParameters" section.

a.

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 stepsmentioned in Section 2.

b.

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:

3.

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:

a.

Platform Tier Command

UNIX Application / bi n/ adt mpl r eport . sh cont ext f i l e= t ar get=

Database / appsut i l / bi n/ adt mpl repor t . sh cont ext f i l e= t ar get=

Windows Application \ bi n\ adt mpl r epor t . cmd cont ext f i l e= t ar get =

Database \ appsut i l \ bi n\ adtmpl r epor t . cmd cont ext f i l e= t ar get =

For example, if you want to customize

$I NST_TOP/ admi n/ i ns t al l / af webprf . sh

On UNIX

$AD_TOP/ bi n/ adt mpl r eport . sh cont ext f i l e=$CONTEXT_FI LE \t ar get =$I NST_TOP/ admi n/ i nst al l / af webprf . sh

On Windows

%AD_TOP%\ bi n\ adtmpl r epor t . cmd cont ext f i l e=%CONTEXT_F I LE% \t ar get =%I NST_TOP%\ admi n\ i ns t al l \ af webpr f . cmd

The adtmplreport utility returns the name and location of the AutoConfig template file. For the above UNIX example it would return:

$FND_TOP/ admi n/ t empl at e/ af webpr f . 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 inthe product driver file. AutoConfig ignores custom template files that are marked with "LOCK".

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



7/27/2019 101026152700

6/20

ad admi n/ t empl ate adconf i g. t xt I NSTE8 / admi n adconf i g. t xt 600 L OCK

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

b.

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

On UNIX

mkdi r $FND_TOP/ admi n/ t empl at e/ cust om

On Windows

mkdi r %FND_TOP%\ admi n\ t empl at e\ cus t om

Copy the AutoConfig template filec.

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/ admi n/ t empl ate/ af webprf . sh \$FND_TOP/ admi n/ t empl at e/ cust om/ af webpr f . sh

On Windows

copy

For example:

copy %FND_TOP%\ admi n\ templ at e\ af webpr f . cmd \%FND_TOP%\ admi n\ t empl at e\ cus t om\ af webpr f . cmd

Edit the custom template filed.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 editAutoConfig template files. Be sure to edit the custom template file.

Verify your customizationsExecute the adchkcfg utility as described in Section 5.3. When this utility runs, it instantiates any custom template files in place of the corresponding AutoConfigtemplate 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.

e.

Note: adchkcfg.sh/cmd instantiates the templates into the following location:

On the application tier:/admin/out/

On the database tier:/appsutil/out//

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

f.

Creating a customer-owned AutoConfig template file4.

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:

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 ApplicationsManager. 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 '//12.0.0'.

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

a.

OA_VAR = c_myt opDef aul t Val ue = / my/ 12. 0. 0Ti t l e = My Pr oduct t opDescr i pt i on = Thi s i s my pr oduct t opOA_TYPE = PROD_TOP

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

b.

On UNIX

mkdi r / admi n/ t empl at e

On Windows

mkdi r \ admi n\ t empl at e

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

c.



7/27/2019 101026152700

7/20

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. WhenAutoConfig runs, it replaces the context variables with the associated values from the context file.

For example, create and edit the file

/ admi n/ t empl at e/ myTempl at e. t xt

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

d.

On UNIX

mkdi r / admi n/ dr i ver

On Windows

mkdi r \ admi n\ dr i ver

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 namefor 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 driver file.

e.

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

my admi n/ t empl ate myTempl ate. t xt I NSTE8 myConf i gurat i on. t xt 660

4.3. Advanced Features of AutoConfig Custom izations

This section discusses advanced features when using AutoConfig Customizations.

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

1.

On UNIX

/ bi n/ adconf i g. sh - nocust om cont ext f i l e=

On Windows

\ bi n\ adconf i g. cmd - nocust om cont ext f i l e=

Preserving customizations after updatesYou 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. Ifthe 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 yourcustomizations.

2.

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.

ReportsThe report produced by the adtmplreport utility can:

3.

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 given configuration fileIdentify the name and location of the configuration file for a given AutoConfig template file

The report utility is located at:

Tier Location

Application / bi n

Database / appsut i l / bi n

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

Platform Command

UNIX adtmpl report . sh context f i l e= l i st cust om

Windows adtmpl repor t . cmd cont ext f i l e= l i st cust om

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

Platform Command

UNIX adtmpl repor t . sh cont ext f i l e=

Windows adtmpl r epor t . cmd cont ext f i l e=

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

Platform Command

UNIX adtmpl repor t . sh cont ext f i l e= t empl ate=

Windows adtmpl repor t . cmd cont ext f i l e= t empl at e=

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

Platform Command

UNIX adtmpl repor t . sh context f i l e= t arget =

Windows adtmpl repor t . cmd context f i l e= t arget =

Section 5: Advanced AutoConfig Features and Utilities

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



7/27/2019 101026152700

8/20

5.1. Running Aut oConfig 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:

per l / bi n/ adconf i g. pl cont ext f i l e= [ product =] parallel

On Database tier:

per l / appsut i l / bi n/ adconf i g. pl cont ext f i l e= parallel

Note: When running AutoConfig simultaneously on multiple nodes, the '-parallel' option must be specified while starting AutoConfig on every node. Otherwise the execution ofAutoConfig 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 aconsolidated report in HTML format. The report displays a summarized view listing all the product tops along with the total instantiation/execution time of the templates within them.The profile report comprises the following sections:

Summary (See a snapshot)This section of the report shows the profile information for all product tops processed in the current AutoConfig run. It shows the following:

Product Top: Short name of each product top.Instantiation Time: Total time taken to instantiate templates from each product top.Execution Time: Total time taken to execute scripts from each product top.Time (%): Percentage of AutoConfig execution time taken to instantiate and execute scripts from each product top.Status: Whether or not all the templates from each product top were successfully instantiated and executed.

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

Details (See a snapshot)This section contains the profile information for all product templates that are only instantiated/executed in the current AutoConfig run. It shows the following:

Script Name: Target name of the template.Instantiation Time: Time taken to instantiate the template.Execution Time: Time taken to execute the instantiated template.Time (%): Percentage of product top processing time taken to process the template.Status: Whether or not the template was successfully processed.Execution Summary: Contains the source and target locations of the template and the execution report of the script. This summary can be viewed by clicking on thescript name link in the detailed report.

AutoConfig can be run in the 'profile' mode by issuing the following command:

On Application Tier:

per l / bi n/ adconf i g. pl cont ext f i l e= [ product=] profile

On Database Tier:

per l / appsut i l / bi n/ adconf i g. pl cont ext f i l e= [ pr oduct =]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 takeeffect 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 theapplications tier and the database tier.

The utility is located in the following location:

Tier Location

Application / bi n

Database / apps ut i l / bi n

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

On UNIX

adchkcf g. sh cont ext f i l e=

On Windows

adchkcf g. cmd cont ext f i l e=

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 bedone during the next normal execution of AutoConfig. The report consists of two tabs:

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

AutoConf ig 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 wi ll 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 StatusDisplays the status of the Service Groups and the corresponding services on the applications tier. This section is present only in the report generated on theapplications 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, thecontent 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 differencesbetween the current and the new configuration file, plus the location of the AutoConfig 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 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 diffbetween the original AutoConfig template and the customized template.

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



7/27/2019 101026152700

9/20

Profile Value ChangesDisplays 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 ValuesDisplays 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 updatesDisplays details for important database updates (non-profile changes) that will be done in the next run of AutoConfig. The table name, column name, the currentcolumn 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 theHTML 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 contextvariable name and generates an HTML or text report containing information about the matched context variables - the variable descriptions, default and current values. The variabledescription contains recommended settings, range of allowed values and links to documents for detailed usage information. Additionally, this utility lists the configuration templateswhere the respective context variables are used. See a snapshot of the generated report.

The Context Variable Information utility can be executed as follows:

Source the Applications environment file as the owner of the application tier file system (APPLMGR user).1.

Run the technology validation utility using the following syntax:2.

On Applications Tier:

perl / bi n/ t xkr un. pl - sc r i pt=GenCt xI nfRep - keywor d=""

On Database Tier:

perl / appsut i l / bi n/ txkr un. pl - scr i pt =GenCt xI nf Rep - keywor d=""

The utility takes the following arguments:

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 is provided, the report will be generated in the directory.

Section 6: Using Aut oConfig 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 Oracle MetaLink Note 388577.1 for converting a Release 12 single instance to Oracle RAC, implementing AutoConfig with Oracle RAC, andimplementing 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 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 Services Topology Data Model stores the entire topological information abouta single Oracle E-Business Suite environment.

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

App ly latest TXK AutoConf ig Temp late pat chUpdate the Oracle Applications file system with the AutoConfig files by applying the latest AutoConfig Template patch (Patch 9386653 for 12.0.X customers and Patch8919489 for 12.1.X customers) to all application tier nodes in your system. Follow the instructions described in Section 3 for applying the patch.

1.

Review init.oraAutoConfig 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. Werecommend 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'sstandards; for example, use of DB_Name as the service name or handling local and remote listeners.

2.

Migrate AutoConfig Patch to the Database tierFollow the steps in Section 3 to migrate the AutoConfig Patch to the database tier.

3.

Run AutoConfig on all Database tier nodesRun AutoConfig on all database tier nodes. Follow the instructions described in Section 2 above.4.

Att ention: The database server instance and the database listener must remain available during the AutoConfig run. All the other database tierservices should be shut down.

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

5.

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

Restart the database listenerStop and restart your database listener.

6.

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 maybe 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 orstopped via the adstrtal or adstpall scripts only if both the service and its service group are enabled.



7/27/2019 101026152700

10/20

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 andstopped via the adstrtal/adstpall scripts. This can be done by enabling the required services and service groups, and disabling those that are not needed.

Checking whether a Service Group/Service is enabled or disabled

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 moredetails, 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 thatare managed via AutoConfig. This list also reports whether a particular service group or service is 'enabled' or 'disabled'.

a.

Enabling or Disabling a Service Group b.

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.

Enabling a Servicec.

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

Disabling a Serviced.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.

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

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

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

Commands for managing processes on the Applications tiera.

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 servicesseparately using the respective service control scripts.

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

Functio nality UNIX Command Windows Command

Start Applications services adst rt al . sh adst r t al . cmd

Stop Applications services adst pal l . sh adst pal l . cmd

Start individual service start start

Stop individual service st op st op

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

Commands for managing processes on the Database tier

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

b.

Functio nality UNIX Command Windows Command

Start database listener process addl nct l . sh st ar t addl nct l . cmd st ar t

Stop database listener process addl nct l . sh st op addl nct l . cmd st op

Start database process addbctl . sh st art addbctl . cmd st art

Stop database process addbct l . sh st op addbct l . cmd st op

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

Section 8: Known Issues

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

On a Multi-node installation with the Forms Services and Batch Processing Services enabled on separate nodes, OAM fails to update the context variables on theBatch 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:a.

On UNIX

sh $I NST_TOP/ admi n/ scr i pts/ adal nct l . sh st ar t

On Windows

%I NST_TOP%\ admi n\ scr i pt s\ adal nct l . cmd st ar t

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

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

AutoCon fig fail s to ex ecute on the Windows Itani um pl atfo rm

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.

2.

Page 10 of 20Using AutoConfig to Manage System Configurations with Oracle Applications Rel...


7/27/2019 101026152700

11/20

Section 9: Frequently Asked Questions

9.1. Overview and Terminology

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

9.2. The Context File

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

9.3. Running Aut oConfig

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

9.4. Customizations

How do I preserve customizations to an AutoConfig-maintained environment?1.What are "Customizable Templates"?2.

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

9.5. Patching AutoConfig

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

9.6. Net Services

What is the Net Services Topology Data Model?1.When is the Net Services Topology Data Model seeded?2.What mechanism is used to generate the tnsnames.ora file?3.How do I seed the Net Services Topology Data Model?4.When do I need to deregister a database tier or an application tier?5.How do I deregister an application tier from the Net Services Topology Data Model?6.How do I deregister a database tier from the Net Services Topology Data Model?7.When do I need to purge the complete Net Services Topology Data Model?8.How do I purge the complete Net Services Topology Data Model?9.

How do I seed the Net Services Topology Data Model after purging it?10. 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 tieror removed the context file. How can I deregister the tier?

11.

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 DataModel?

12.

How do I configure AutoConfig to generate the failover aliases?13.For which database versions can I define failover aliases?14.

9.7. Database Connectivity

Should the database server remain available during the AutoConfig run?1.What is the use of the context variable s_apps_jdbc_connect_descriptor?2.When do I need to reset (empty) the context variable s_apps_jdbc_connect_descriptor?3.Does AutoConfig support spfiles?4.What steps do I need to follow to maintain my database connectivity when I migrate my database from one host/platform to another?5.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 tierconnects to the new database?

6.

9.8. Oracle RAC

My Release 12 instance is configured with RAC. Now I want to migrate to AutoConfig. How do I achieve that?1.My Release 12 instance is configured as non-RAC. Now I want to migrate to RAC using AutoConfig. What steps should I follow?2.

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?3.My RAC environment uses an spfile. How do I ensure that my spfile is in sync with the init.ora files?4.

9.9. Windows Specific Requirements

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

9.10. Troubleshootin g

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

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 iscollected into an XML repository, called theApplications context. There is one Applications context for each application tier, and one for each database tier. When AutoConfig runs, ituses 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:



7/27/2019 101026152700

12/20

A serveris 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 somecomponents of the Release 12 architecture, in which case the replacement term ofservice orservice group is used.

A 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 machineon which a particular node is installed.

A tieris 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 applicationnode, 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, includingForms 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 an Oracle10g ORACLE_HOME and the Applications databaseinstance 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 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 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 theapplmgruser). 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 envi ronment 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:

Components Location Description

Appl icat ion s Cont ext On the application tier:/appl/admin

On the database tier:/appsutil

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

AutoConf ig Tem plat e FilesOn the application tier:/admin/template

For example:/admin/template/admin/template

On the database tier:/appsutil/template

Include named tags which are replaced with instance-specific information from the ApplicationsContext. There is one template file for each configuration file.

For example:apps_nt.confapps_ux.conf

AutoConf ig Fi le Dri ver 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 AutoConfig Template Files, their destination locations, and thecommands to be executed, for example, the commands to update profile options. Every ProductTop contains its own AutoConfig File Driver.

AutoConf ig Sc rip ts On the application tier:/bin

On the database tier:/appsutil/bin

Provide a simplifiedinterface to the AutoConfig APIs.



7/27/2019 101026152700

13/20

For example:adautocfg.sh/adautocfg.cmdadconfig.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.

Scripts Location Description

adautocfg.sh

adautocfg.cmd

On the application tier:/admin/scripts

On the database tier:/appsutil/scripts/

A wrapper script that calls adconfig.sh/adconfig.cmd. Instantiates template files with valuesspecific to the instance (taken from the Applications for the application tier and the databasecontext 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 earlier versions of AutoConfig adconfig.sh/adconfig.cmdused to call the Java API to start AutoConfig.

adconfig.pl On the application tier:/bin


A wrapper script that calls the Java API to start AutoConfig.

adchkcfg.sh

adchkcfg.cmd

On the application tier:/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:/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: In Oracle Applications Manager (OAM), navigate to Site Map. Click on AutoConfig. Click on Edit Parameters to edit the relevant context file.

Att ention: Manually editing a context file is not supported. Many context variables have dependencies between each other. The OAMAutoConfig resolves all these dependencies when changing the value of a variable. Manually editing the context file could bring the datainto an inconsistent state.

Back to FAQ List

3) Can I use adbldxml.pl t o generate context fi les 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.

per l / cl one/ bi n/ adcl onect x. pl r et r i eve

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 locationspecified by the script.

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

Execute the following command on the database tier:

per l / appsut i l / cl one/ bi n/ adcl onect x. pl r et r i eve

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.



7/27/2019 101026152700

14/20

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:

per l / appsut i l / cl one/ bi n/ adcl onect x. pl r et r i eve

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 Aut oConfig

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

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 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:/admin/out/

On the database tier:/appsutil/out//

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

You can run restore.sh (UNIX) orrestore.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.



7/27/2019 101026152700

15/20

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 i s a non-customizable template. If the "LOCK" keyword i s not seen, then that template canbe customized.

For example:

f nd admi n/ t empl ate apps_conf _1013. tmp I NSTE8 / 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 passedvia 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 latestTXK product patches for 12.0.X. Patch 8919489 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 8919489 for 12.1.X customers), perform the steps in the order listed inSection 3. This patch is required only for 12.0.X.

Back to FAQ List

9.6. Net Services

1) What is the Net Services Topol ogy 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 eachnode 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 DescriptorsApp lic ation 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 Topolo gy 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 relevantdata 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 OracleRAC.

Back to FAQ List

4) How do I seed the Net Services Topolo gy 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 HostDatabase PortDatabase NameDatabase SID

You should deregister the tierbefore the tier is decommissioned.



7/27/2019 101026152700

16/20

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 / bi n/ adgent ns. pl cont ext f i l e= - r emoveser ver

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:

per l / appsut i l / bi n/ adgent ns. pl cont ext f i l e= - r emoves er ver

Back to FAQ List

8) When do I need to purge the com plete Net Services Topolog y 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 / bi n/ adgent ns. pl cont ext f i l e= - r emovesys t em

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 alreadydecommissioned 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:

Locate the system name:1.

The system name is the database nameObtain it by running the following SQL query:

sel ect DB_NAME f r om FND_DATABASES;

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

Run this SQL query on the database tier:

sel ect NAME, SERVER_TYPE f r om FND_APP_SERVERS, FND_NODESwher e FND_APP_SERVERS. NODE_I D = FND_NODES. NODE_I D and

SERVER_TYPE=' DB' and FND_NODES. NODE_NAME=upper ( ' host name' ) ;

Run this SQL query on the application tier:

sel ect NAME, SERVER_TYPE f r om FND_APP_SERVERS, FND_NODESwher e FND_APP_SERVERS. NODE_I D = FND_NODES. NODE_I D and

SERVER_TYPE=' APPS' and FND_NODES. NODE_NAME=upper ( ' host name' ) ;

Run the following PL/SQL block:3.

begi nFND_NET_SERVI CES. remove_ser ver ( SYSTEM_NAME, SERVER_NAME) ;end;/commi t ;/

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 theData 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:

sel ect DB_NAME f r om FND_DATABASES;

Run the following PL/SQL block:



7/27/2019 101026152700

17/20

begi nFND_NET_SERVI CES. r emove_syst em( SYSTEM_NAME) ;end;/commi t ;/

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:

' SERVI CE_ NAME: I NSTANCE_NAME1, SERVI CE_ NAME: I NSTANCE_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:

Update the context variable s_alt_service_instances in the database tier context file, applying the failover rules as described above1.Run AutoConfig on all database tiers2.Run AutoConfig on all application tiers3.

These steps will generate the failover TNS alias _FO with a description list as configured in s_alt_service_instances. Before you can use these aliases, you willhave 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 _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 HostDatabase Port

Back to FAQ List

4) Does AutoConfig su pport 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: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 TopologyData Model?"

1.

After the migration:Reset the context variable s_apps_jdbc_connect_descriptor in the context file for the application tier to an empty string.1.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.2.

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 applicationtier 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



7/27/2019 101026152700

18/20

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 Metalink Note 388577.1.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_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 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

Generate the pfile from the existing spfile by executing the following command in the database.1.

SQL> create pfile='' from spfile;

Note: The provided should be different from init.ora. Otherwise, it would overwrite the existing init.ora file generated in the lastAutoConfig run.

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 filesonly if they are not already present.

2.

Run AutoConfig to create the new init.ora and _APPS_BASE.ora files.3.Diff the pfile with the init.ora and the _APPS_BASE.ora files to view the customizations done in the spfile.4.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 inthe corresponding .ora files.

5.

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.

In order to create a new spfile with the latest AutoConfig changes, move the existing spfile to some other location.7.Shutdown the database and start it again.8.Connect to the database and create the new spfile using the following command:9.

SQL>create spfile from pfile;

This will create the spfile containing the latest AutoConfig changes as well as the existing customizations.Shutdown the database and start it again for the new spfile location to be reflected in the Database.10.

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 corr ect settin g 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 downloadActivePerlfrom perl.com. Perl has to be in the PATH in order for AutoConfig to run.

Back to FAQ List

9.10. Troubleshootin g

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 t he 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 theAutoConfig 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 theproblem to Oracle Support.

Error encountered in t he 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 toOracle Support.



7/27/2019 101026152700

19/20

Note: Refer to the question "Where are the log files that AutoConfig creates?" for the location of the log file.

Back to FAQ List

App endix A: Speci fic atio n fo r Au toCo nfi g Dri ver Fi le Syn tax

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 or separated fields. The following table lists the fields and their contents.

Field Name Description

Product Name Specifies the short name for t he product

AutoConfig templatedirectory

Directory underneath the product top that hosts the AutoConfig template f ile

AutoConfig template 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 i nstantiating, 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 notalready exist.

INSTALL_PRF > In addition to instantiating, AutoConfig executes the resulting configuration file during the PROFILE phase if the configuration file does notalready exist.

INSTALL_APPLY> In addition to instantiating, AutoConfig executes the resulting configuration file during theAPPLY phase if the configuration file does notalready exist.

Configuration directory AutoConfig places the instantiated configuration file in this directory

Configuration f ile Name of the instantiated configuration f ile

Configuration filepermission (UNIX only)

AutoConfig generates the configuration file with the provided UNIX-style permissions

For example, in the case of the driver file entry:

my admi n/ t empl ate myTempl ate. txt I NSTE8 myConfi gur at i on. t xt 660

AutoConfig would instantiate the template file /admin/template/myTemplate.txt and generate the configuration file myConfiguration.txt into the Portal directory (the Portaldirectory is instantiated from ) with 660 (read and write for user and group) permission. No supplementary information is available at present.

App endix B: Setti ng t he PERL5LIB envi ronment vari able on th e Database tier

By default, the PERL5LIB environment variable is set to the following on the Database tier:

/ per l / l i b/ 5. 8. 3: / per l / s i t e_per l / 5. 8. 3: / appsut i l / per l

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 as follows:

expor t PERL5LI B=/ per l / l i b/ 5. 10. 0: / per l / si t e_per l / 5. 10. 0: / appsut i l / per l

Change Log

Date Description

July 15, 2010 Added reference to the R12.TXK.B.DELTA.3 (Patchset 8919489).

Jun 10, 2010 Added reference to the R12.TXK.A.DELTA.7 (Patchset 9386653).

Feb 17, 2010 Added reference to the R12.TXK.B.DELTA.2 (Patchset 7651166).

Dec 31, 2009 Added appendix regarding setting the PERL5LIB variable on the database tier.

Nov 04, 2009 Added information about the new CheckConfig section.

Oct 19, 2009Enhanced Section 3.2 to have a step for running AutoConfig on a newly createdOracle Home.

Sep 10, 2009 Modified Section 3.2 Step 3 to clarify the minimum supported jre version.

Aug 28, 2009Added note about TXK AutoConfig Template patch not being released for12.1.1 as of now.

May 14, 2009 Corrected typos in Section 2

Apr 30, 2009 Restructured the doc

Enhanced the Table of ContentsRestructured and split Section 2 (System

Documents

101026152700