Professional Documents
Culture Documents
Page 1 of 20
Using AutoConfig to Manage System Configurations in Oracle E-Business Suite Release 12 [ID 387859.1] Modified 14-OCT-2010 Type WHITE PAPER Status PUBLISHED
Section 3: Patching AutoConfig 3.1. Applying the Latest AutoConfig Updates 3.2. Enabling AutoConfig on a New Oracle Home Section 4: Customizing AutoConfig-Managed Configurations 4.1. Prerequisites for AutoConfig Customizations 4.2. Implementing AutoConfig Customizations 4.3. Advanced Features of AutoConfig Customizations Section 5: Advanced AutoConfig Features and Utilities 5.1. Running AutoConfig in Parallel Across Multiple Nodes 5.2. Profiling An AutoConfig Run 5.3. Using the Check Config Utility 5.4. Using the Context Variable Information Utility
Appendix A: Specification for AutoConfig Driver File Syntax Appendix B: Setting the PERL5LIB environment variable on the Database tier Change Log
Conventions Attention: Windows users - this document typically uses UNIX syntax when specifying directories. Substitute the appropriate Windows syntax where applicable.
Convention APPLMGR ORACLE CONTEXT_NAME CONTEXT APPSpwd APPSuser/APPSpwd Monospace Text \ AutoConfig template file
Meaning User who owns the Applications file system (APPL_TOP and application tier technology stack) User who owns the database file system (RDBMS ORACLE_HOME and database files). Logical name for your Context. Default: <SID>_<hostname> Full path to the context file (either Applications context file or database context file). Default: <INST_TOP>/appl/admin/<CONTEXT_NAME>.xml and <RDBMS_ORACLE_HOME>/appsutil/<CONTEXT_NAME>.xml Applications database user password Applications database user name and password 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. An AutoConfig template file contains named tags, which are replaced with instance-specific information when AutoConfig runs. For example: <FND_TOP>/admin/template/afwebprf.sh AutoConfig template files should not be edited.
To customize AutoConfig-managed configuration files, copy the AutoConfig template file to a custom template file and edit the custom template file. For example: <FND_TOP>/admin/template/custom/afwebprf.sh When AutoConfig detects a custom template file, AutoConfig instantiates this file in place of the AutoConfig template file.
Directory where Oracle delivers AutoConfig template files. There is an AutoConfig template directory for every product. Location: <product_top>/admin/template <RDBMS ORACLE_HOME>/appsutil/template For example: <FND_TOP>/admin/template <ORACLE_HOME>/appsutil/template
Directory where you keep your customized AutoConfig template files. Location: <product_top>/admin/template/custom <RDBMS ORACLE_HOME>/appsutil/template/custom For example: <FND_TOP>/admin/template/custom <ORACLE_HOME>/appsutil/template/custom The instantiated configuration file that is created when AutoConfig runs. For example: <INST_TOP>/admin/install/afwebprf.sh Text enclosed in angle brackets represents a variable. Substitute a value for the variable text. Do not type the angle brackets.
https://support.oracle.com/CSP/main/article?cmd=show&type=NOT&doctype=WHIT... 2010/10/25
Using AutoConfig to Manage System Configurations with Oracle Applications Releas... Page 2 of 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.
The Applications Release 12 application tier is AutoConfig-enabled, and has an Applications context file stored in the INST_TOP as <INST_TOP>/appl/admin/<CONTEXT_NAME>.xml. The Applications Release 12 database tier created via Rapid Install is also AutoConfig-enabled, and has a database context file stored in the RDBMS ORACLE_HOME as <RDBMS ORACLE_HOME>/appsutil/<CONTEXT_NAME>.xml. When a change is made to any of the context files or any of the template files, the AutoConfig utility updates the Applications Release 12 configuration. AutoConfig can also be used to start and stop all Applications system services that it manages.
On Database Tier:
<RDBMS_ORACLE_HOME>/appsutil/scripts/<CONTEXT_NAME>
adchkcfg.sh/cmd
On Applications Tier:
<AD_TOP>/bin
On Database Tier:
<RDBMS_ORACLE_HOME>/appsutil/bin
This script may be run before running AutoConfig to review the changes on running AutoConfig. This will generate a report showing the differences between the existing configuration and what the configuration would be after running AutoConfig. More Details This script can be used to find out detailed information about context variables and the templates in which they are used, given all or part of a context variable name as a keyword. More Details This script can be used to gather information regarding the location of the AutoConfig templates, provided the location of the instantiated files and vice versa. More Details This script is used while applying patches to the database tier. Running this script generates appsutil.zip which may be copied over to the database tier to migrate the patch to the database tier. More Details
GenCtxInfRep.pl
On Applications Tier:
<FND_TOP/patch/115/bin
On Database Tier:
<RDBMS_ORACLE_HOME>/appsutil/bin
On Database Tier:
<RDBMS_ORACLE_HOME>/appsutil/bin
admkappsutil.pl
On Applications Tier:
<AD_TOP>/bin
Besides the above tools, there are start and stop tools that are used to manage the run-time processes of EBS Services. These tools are listed in Section 7.
On Windows:
<RDBMS_ORACLE_HOME>\appsutil\bin\adchkcfg.cmd contextfile=<CONTEXT_FILE>
On Windows:
<AD_TOP>\bin\adchkcfg.cmd contextfile=<CONTEXT_FILE>
https://support.oracle.com/CSP/main/article?cmd=show&type=NOT&doctype=WHIT... 2010/10/25
Using AutoConfig to Manage System Configurations with Oracle Applications Releas... Page 3 of 20
After the Net Services Topology Information is manually cleaned up using one of the supported procedures(eg. fnd_conc_clone.setup_clean). Subsequently, AutoConfig must be run on the application tier nodes. After registration of a RAC node. After setting up the APPL_TOP on a shared file system. All other cases where documentation says that AutoConfig should be run on the database tier. Execute the following command to run AutoConfig on the database tier. On Unix:
sh <RDBMS_ORACLE_HOME>/appsutil/scripts/<CONTEXT_NAME>/adautocfg.sh
On Windows:
<RDBMS_ORACLE_HOME>\appsutil\scripts\<CONTEXT_NAME>\adautocfg.cmd
Attention: The database server and the database listener must remain available during the AutoConfig run. All the other database tier services should be shut down. Running AutoConfig may change your existing environment files. After running AutoConfig, you should always set the environment before you run any Applications utilities, in order to apply the changed environment variables.
On Windows:
<INST_TOP>\admin\scripts\adautocfg.cmd
Attention: The database server and the database listener must remain available during the AutoConfig run. Only the application tier servers should be shut down. Running AutoConfig may change your existing environment files. After running AutoConfig, you should always set the environment before you run any Applications utilities, in order to apply the changed environment variables.
One log file is created per AutoConfig session. It will contain details of every action that AutoConfig performed during the run.
where:<MMDDhhmm> = (month, day, hour, minute of AutoConfig run) To roll back an AutoConfig session, execute the following commands: On UNIX
restore.sh
On Windows
restore.cmd
https://support.oracle.com/CSP/main/article?cmd=show&type=NOT&doctype=WHIT... 2010/10/25
Using AutoConfig to Manage System Configurations with Oracle Applications Releas... Page 4 of 20
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 <AD_TOP>/bin/admkappsutil.pl This will create appsutil.zip in <INST_TOP>/admin/out On the database tier (as the ORACLE user): Copy or FTP the appsutil.zip file to the <RDBMS ORACLE_HOME>
cd <RDBMS ORACLE_HOME> unzip -o appsutil.zip
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 in Section 2.
In order to enable AutoConfig on the database tier, perform the following steps in the order listed: 1. Apply patch 6636108 on the Applications tier Customers who are on 12.0.X need to apply this patch which delivers the adbldxml utility for generating the context file on the database tier. This patch is also included in the latest AutoConfig Template patch (Patch 9386653 for 12.0.X customers and Patch 8919489 for 12.1.X customers). Note: If your instance is on 12.0.X and is not upgraded to 10.1.3.3 AS patchset, Patch 4585869 needs to be applied in order to use the adbldxml utility. 2. Copy AutoConfig to the RDBMS ORACLE_HOME Update the RDBMS ORACLE_HOME file system with the new AutoConfig files delivered in the above patch following Step 2 in Section 3.1. 3. Install JRE on the Database tier Follow the steps below to ensure that jre version on the applications tier and the database tier is atleast 1.5 or higher: If you are using a "fully certified" platform, please refer to Metalink Note 418664.1 to install jre under the <RDBMS_ORACLE_HOME>/appsutil directory. If you are using a "Database tier only" platform, please refer to Metalink Note 456197.1 to install jre under the <RDBMS_ORACLE_HOME>/appsutil directory. 4. Generate the Database Context File Execute the following command to create your Database Context File:
perl <RDBMS_ORACLE_HOME>/appsutil/bin/adbldxml.pl
Attention: If you build the context file for an instance that runs on RAC, all your RAC instances have to be up and running while executing the adbldxml utility. The utility connects to all RAC instances to gather information about the configuration. 5. Run AutoConfig on the Database tier Run AutoConfig on the Database tier by executing the below command: On Unix:
<RDBMS_ORACLE_HOME>/appsutil/bin/adconfig.sh contextfile=<context_file>
On Windows:
<RDBMS_ORACLE_HOME>\appsutil\bin\adconfig.cmd contextfile=<context_file>
Historically, Oracle did not document procedures on how to implement customizations. If you tried to customize your AutoConfig-generated files by manually editing them, your changes were lost every time AutoConfig ran. To avoid this, Oracle Support may have instructed you to add your customizations between "Begin/End customizations" blocks in the configuration files. This limited and inflexible method has now been superseded by a fully supported mechanism to extend your AutoConfig-maintained environment with maximum flexibility, and preserving your extensions every time AutoConfig is run.
https://support.oracle.com/CSP/main/article?cmd=show&type=NOT&doctype=WHIT... 2010/10/25
Using AutoConfig to Manage System Configurations with Oracle Applications Releas... Page 5 of 20
The adcustomizer script: a. b. c. d. Detects all configuration files that have "Begin/End customizations" blocks. Copies the corresponding AutoConfig template files to custom template files. Appends the contents in the "Begin/End customizations" blocks to the end of the custom template files. Removes the "Begin/End customizations" blocks from the configuration file.
Review the logfile generated by the adcustomizer script. Ensure that all your customizations were successfully migrated to the custom template file(s) by examining the generated custom template file(s).
Note: All files managed by AutoConfig have the following header: ################################################################ # # This file is automatically generated by AutoConfig. It will be read and # overwritten. If you were instructed to edit this file, or if you are not # able to use the settings created by AutoConfig, refer to Metalink # document 387859.1 for assistance. # ################################################################
After identifying your customization need, perform the steps associated with it. Oracle supports the following types of customizations: Changing the value of an existing context variable Adding a new context variable to the context file Customizing an AutoConfig template file delivered by Oracle Creating 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. Refer to Oracle Applications System Administrator's Guide Configuration for details of how to use the Oracle Applications Manager Context Editor. b. Run AutoConfig Depending on whether the context variable belongs to the application tier or the database tier, run AutoConfig on the appropriate tier, following the steps mentioned in Section 2. 2. 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 not maintained by AutoConfig. Refer to the Help pages available on Oracle Applications Manager. The relevant information for adding custom context variables is located in the "System Configuration" > "AutoConfig" > "Manage Custom Parameters" section. 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 the configuration file you want to customize:
Platform UNIX Tier Application Database Windows Application Database Command
<AD_TOP>/bin/adtmplreport.sh contextfile=<CONTEXT_FILE> target=<configurationfile> <RDBMS ORACLE_HOME>/appsutil/bin/adtmplreport.sh contextfile=<CONTEXT_FILE> target=<configurationfile> <AD_TOP>\bin\adtmplreport.cmd contextfile=<CONTEXT_FILE> target=<configurationfile> <RDBMS ORACLE_HOME>\appsutil\bin\adtmplreport.cmd contextfile=<CONTEXT_FILE> target=<configuration>
On Windows
The adtmplreport utility returns the name and location of the AutoConfig template file. For the above UNIX example it would return: $FND_TOP/admin/template/afwebprf.sh You cannot customize all AutoConfig template files. The AutoConfig template file cannot be customized if the "LOCK" keyword appears in the template file's entry in the product driver file. AutoConfig ignores custom template files that are marked with "LOCK". For example, the following entry in <AD_TOP>/admin/driver/adtmpl.drv would prevent customization of the file adconfig.txt:
https://support.oracle.com/CSP/main/article?cmd=show&type=NOT&doctype=WHIT... 2010/10/25
Using AutoConfig to Manage System Configurations with Oracle Applications Releas... Page 6 of 20
b. Create the custom template directory Create a directory named "custom" at the location where the AutoConfig template file resides. For example, if you want to customize <FND_TOP>/admin/template/afwebprf.sh, execute the following command as the applmgr user: On UNIX
mkdir $FND_TOP/admin/template/custom
On Windows
mkdir %FND_TOP%\admin\template\custom
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 <AutoConfig template file> <custom template file> For example:
cp -i $FND_TOP/admin/template/afwebprf.sh \ $FND_TOP/admin/template/custom/afwebprf.sh
On Windows
copy <AutoConfig template file> <custom template file>
For example:
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 Windows. Note: It is not supported to edit AutoConfig template files. Be sure to edit the custom template file. e. Verify your customizations Execute the adchkcfg utility as described in Section 5.3. When this utility runs, it instantiates any custom template files in place of the corresponding AutoConfig template file. The adchkcfg utility generates a report with information about all files and profile options that will be changed during the next normal run of AutoConfig. Verify that your customizations would be applied as expected in your next AutoConfig run. Note: adchkcfg.sh/cmd instantiates the templates into the following location: On the application tier:
<INST_TOP>/admin/out/<MMDDhhmm>
f. Run AutoConfig Run AutoConfig as described in Section 2. When AutoConfig runs, it instantiates any custom template file in place of the corresponding AutoConfig template file. 4. Creating a customer-owned AutoConfig template file You can create an AutoConfig template file of your own. This will enable you to develop custom applications that AutoConfig can configure and maintain. Perform the following tasks in the order listed: a. Define a product_top Use the Oracle Applications Manager Context Editor to add your custom product_top to the context file. Refer to the Help pages available in Oracle Applications Manager. The relevant information for adding custom context variables is located in the "System Configuration"> "AutoConfig"> "Manage Custom Parameters" section. Choose the variable type "PROD_TOP" when adding the product_top variable. The default value for the product_top variable must be set to '<s_at>/<product name>/12.0.0'. For example, define the product top for the product 'my' as follows:
OA_VAR = c_mytop Default Value = <s_at>/my/12.0.0 Title = My Product top Description = This is my product top OA_TYPE = PROD_TOP
b. Create the customer-owned AutoConfig template directory Create the directory where your AutoConfig template files will reside. Execute the following command as the applmgr user: On UNIX
mkdir <c_mytop>/admin/template
On Windows
mkdir <c_mytop>\admin\template
c. Develop the customer-owned AutoConfig template file Create the custom AutoConfig template file in the custom product top AutoConfig template directory. There are no file name restrictions, and the new template file can
https://support.oracle.com/CSP/main/article?cmd=show&type=NOT&doctype=WHIT... 2010/10/25
Using AutoConfig to Manage System Configurations with Oracle Applications Releas... Page 7 of 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. When AutoConfig runs, it replaces the context variables with the associated values from the context file. For example, create and edit the file <c_mytop>/admin/template/myTemplate.txt d. Create the customer-owned AutoConfig driver directory Create the directory where your AutoConfig driver file will reside. Execute the following command as the applmgr user: On UNIX
mkdir <c_mytop>/admin/driver
On Windows
mkdir <c_mytop>\admin\driver
e. Develop the customer-owned AutoConfig driver file The AutoConfig driver file instructs AutoConfig where to place the generated configuration file. Place the driver file in the custom AutoConfig driver directory. The name for the driver file is defined as: <product>tmpl.drv. In this example, the driver file would be named: mytmpl.drv. Refer to Appendix A: Specification for AutoConfig Driver File Syntax for information on the format of the driver file. For example, to have AutoConfig instantiate the above example template file, the driver file would need to contain this line:
my admin/template myTemplate.txt INSTE8 <s_pt> myConfiguration.txt 660
On Windows
<AD_TOP>\bin\adconfig.cmd -nocustom contextfile=<CONTEXT_FILE>
2. Preserving customizations after updates You must review your customizations whenever AD Patch delivers a new version of an AutoConfig template file for which you edited the corresponding custom template file. If the customizations are still required, copy the new version of the AutoConfig template file to the custom template directory, and edit the custom template file with your customizations. AutoConfig checks that your custom template files are of the same versions as the AutoConfig template files, and will not run if it detects any version mismatch. 3. Reports The report produced by the adtmplreport utility can: List all customized files in an Oracle E-Business Suite instance List all AutoConfig template files, their custom template files and their configuration files Identify the name and location of the AutoConfig template file and the custom template file for a given configuration file Identify the name and location of the configuration file for a given AutoConfig template file The report utility is located at:
Tier Application Database Location <AD_TOP>/bin <RDBMS ORACLE_HOME>/appsutil/bin
To list all files that you customized in an Oracle E-Business Suite instance:
Platform UNIX Windows Command adtmplreport.sh contextfile=<CONTEXT_FILE> listcustom adtmplreport.cmd contextfile=<CONTEXT_FILE> listcustom
To list all configurations files, their AutoConfig template files and their custom template files:
Platform UNIX Windows Command adtmplreport.sh contextfile=<CONTEXT_FILE> adtmplreport.cmd contextfile=<CONTEXT_FILE>
To identify the AutoConfig template and custom template file for a given configuration file:
Platform UNIX Windows Command adtmplreport.sh contextfile=<CONTEXT_FILE> target=<configurationfile> adtmplreport.cmd contextfile=<CONTEXT_FILE> target=<configurationfile>
https://support.oracle.com/CSP/main/article?cmd=show&type=NOT&doctype=WHIT... 2010/10/25
Using AutoConfig to Manage System Configurations with Oracle Applications Releas... Page 8 of 20
Note: When running AutoConfig simultaneously on multiple nodes, the '-parallel' option must be specified while starting AutoConfig on every node. Otherwise the execution of AutoConfig processes on individual nodes will not be synchronized, which might result in inconsistent filesystem or database updates.
The Check Config utility may be run by executing the following command: On UNIX
adchkcfg.sh contextfile=<CONTEXT_FILE>
On Windows
adchkcfg.cmd contextfile=<CONTEXT_FILE>
This script generates both HTML and text reports. The reports provide information about all file changes, profile option changes and other important database updates that will be done during the next normal execution of AutoConfig. The report consists of two tabs: File System Changes (See a snapshot) This report is divided into the following sections: AutoConfig Context File Changes Displays information about the location of the context file, the content of the currently active context file, the content of the context file that will be generated in the next AutoConfig run. In addition it also displays an HTML report highlighting the differences between the current and the new context file, if any. Service Group Status Displays the status of the Service Groups and the corresponding services on the applications tier. This section is present only in the report generated on the applications tier. Changed Configuration Files Displays a list of all the files that will be changed during an AutoConfig execution. For each file, information is displayed about the location of the runtime file, the content of the currently active file, the content of the file that will be generated in the next AutoConfig run. In addition, an HTML report highlights the differences between the current and the new configuration file, plus the location of the AutoConfig template file (if applicable). New Configuration Files Displays a list of all the new files that will be created during an AutoConfig execution. For each file, information is displayed about the location of the runtime file, the content of the new file and the location of the AutoConfig template file. Template Customizations This section has been introduced in Oracle Techstack Release Update Pack 2 for 12.1. It displays a list of all customized AutoConfig templates and reports the diff between the original AutoConfig template and the customized template. Database Changes (See a snapshot) This report is divided into the following sections:
https://support.oracle.com/CSP/main/article?cmd=show&type=NOT&doctype=WHIT... 2010/10/25
Using AutoConfig to Manage System Configurations with Oracle Applications Releas... Page 9 of 20
Profile Value Changes Displays details of only those profiles whose value would be changed in the next AutoConfig run. For each such profile, the current value in the Database, the new AutoConfig value that would be set for it, the Profile Level and the name of the AutoConfig script that changes the profile value is displayed. Profile Values Displays details as in previous section for all Apps Database profiles managed by AutoConfig, irrespective of whether their value would change or not in the next AutoConfig run. Other Database updates Displays details for important database updates (non-profile changes) that will be done in the next run of AutoConfig. The table name, column name, the current column value in the Database and the new AutoConfig value is displayed along with the name of the updating AutoConfig script and a brief description. The script also creates a zip file report "ADXcfgcheck.zip" that contains all the files and reports mentioned above. The ADXcfgcheck.zip can be copied to a local desktop PC and the HTML report can be viewed there without breaking the hyper-links in the report.
On Database Tier:
perl <ORACLE_HOME>/appsutil/bin/txkrun.pl -script=GenCtxInfRep -keyword="<keyword>"
The utility takes the following arguments: contextfile (optional): complete path to the context file. By default, it is set to the value of <CONTEXT_FILE> keyword (required): all or part of a context variable name reportType (optional): the report type. Valid values are html (default) or text outfile (required): the report file. If only the name and not the complete path for the report file is provided, the report will be generated in the <APPLTMP> directory.
Note: Refer to Oracle MetaLink Note 388577.1 for converting a Release 12 single instance to Oracle RAC, implementing AutoConfig with Oracle RAC, and implementing load balancing of database connections on Oracle RAC for Release 12 application tiers.
Oracle E-Business Suite Release 12 delivers the infrastructure to generate a complete tnsnames.ora file required for Oracle RAC. This includes Instance aliases for each database tier node Load balance aliases with address lists for each database tier node FNDSM and FNDFS aliases (used by the CP Service Manager) for each application tier node Virtual hostname support
The tnsnames.ora file is dynamically generated using the Net Services Topology Data Model. The Net Services Topology Data Model stores the entire topological information about a single Oracle E-Business Suite environment. Complete the steps in this section (in the order listed) to support AutoConfig on Oracle RAC: 1. Apply latest TXK AutoConfig Template patch Update the Oracle Applications file system with the AutoConfig files by applying the latest AutoConfig Template patch (Patch 9386653 for 12.0.X customers and Patch 8919489 for 12.1.X customers) to all application tier nodes in your system. Follow the instructions described in Section 3 for applying the patch. 2. Review init.ora AutoConfig will not overwrite your existing init.ora file. However, when no init.ora file exists, AutoConfig will generate an init.ora that is compatible with Oracle RAC. We recommend creating a backup of the existing init.ora file and let AutoConfig generate a new init.ora file. This will ensure that the init.ora file conforms to the Oracle's standards; for example, use of DB_Name as the service name or handling local and remote listeners. 3. Migrate AutoConfig Patch to the Database tier Follow the steps in Section 3 to migrate the AutoConfig Patch to the database tier. 4. Run AutoConfig on all Database tier nodes Run AutoConfig on all database tier nodes. Follow the instructions described in Section 2 above. Attention: The database server instance and the database listener must remain available during the AutoConfig run. All the other database tier services should be shut down. 5. Run AutoConfig on the Application tier Run AutoConfig on each Application tier. Use the adautocfg.sh/.cmd command described in Section 2. Attention: The database server and the database listener must remain available during the AutoConfig run. 6. Restart the database listener Stop and restart your database listener. Your system is now AutoConfig-enabled with Oracle RAC. Refer to Section 2 for information on managing system configuration.
https://support.oracle.com/CSP/main/article?cmd=show&type=NOT&doctype=WHIT... 2010/10/25
Using AutoConfig to Manage System Configurations with Oracle Applications Rel... Page 10 of 20
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.
<control_script> stop
<control_script> stop
Note: Please refer to Section 3 in My Oracle Support Knowledge Document 406558.1 for the control script names for the respective services. b. Commands for managing processes on the Database tier All the scripts listed below are located in <RDBMS ORACLE_HOME>/appsutil/scripts/<CONTEXT_NAME>.
Functionality Start database listener process Stop database listener process Start database process Stop database process UNIX Command
addlnctl.sh start <SID> addlnctl.sh stop <SID> addbctl.sh start addbctl.sh stop
Windows Command
addlnctl.cmd start <SID> addlnctl.cmd stop <SID> addbctl.cmd start addbctl.cmd stop
Note: To manage Oracle Configuration Manager (OCM) processes running on an Oracle E-Business Suite Release 12 instance, refer to the OCM documentation. OCM processes are not managed by standard service management scripts such as adstrtal.sh and adstpall.sh.
On Windows
%INST_TOP%\admin\scripts\adalnctl.cmd start <LOCAL>
a. Enable management of the TNS Listener Service via the adstrtal/adstpall scripts on the Forms Services node. 'Enable' the TNS Listener Service by following the steps mentioned in Section 7. Stop all middle tier services using the adstpall.sh/cmd script. Startup the middle tier services using the adstrtal.sh/cmd script. 2. AutoConfig fails to execute on the Windows Itanium platform Apply the one-off patch, 6501658, which delivers the fix for this issue. Customers need to be on at least the 12.0.2 patchset in order to apply this one-off patch.
https://support.oracle.com/CSP/main/article?cmd=show&type=NOT&doctype=WHIT... 2010/10/25
Using AutoConfig to Manage System Configurations with Oracle Applications Rel... Page 11 of 20
9.4. Customizations
1. 2. 3. 4. 5. 6. How do I preserve customizations to an AutoConfig-maintained environment? What are "Customizable Templates"? What are "Non-Customizable templates"? How do I determine whether it is a "Customizable/Non-Customizable" template? What is the mechanism for sending apps user/password to a new custom template? What do I do when a patch or Oracle documentation instructs me to manually modify an AutoConfig-maintained file?
9.10. Troubleshooting
1. What should I do if my AutoConfig script exits with non-zero status?
https://support.oracle.com/CSP/main/article?cmd=show&type=NOT&doctype=WHIT... 2010/10/25
Using AutoConfig to Manage System Configurations with Oracle Applications Rel... Page 12 of 20
A server is the traditional term for a process that provides a particular functionality. This term, in the sense of a denoting a single process, is less appropriate for some components of the Release 12 architecture, in which case the replacement term of service or service group is used. 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 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 define the set of processes that will be started on each application node, and can be activated or deactivated according to the function the node is to perform. These include Forms services, Web services, and Batch Processing services (Concurrent Processing server). A key role of these services is to provide communication between the desktop tier and the database tier. The database tier consists of the database server, which stores all the data of the Release 12 system in an Oracle database. The primary location of the files used by the application tier servers is the APPL_TOP, whereas the primary location of the files used by the database tier server is the Oracle10g ORACLE_HOME. Back to FAQ List 3) How can I identify the application tier and the database tier in a multi-node system? Answer: A node can support one or more servers (or services), and can therefore belong to one or more tiers. In a single-node system, that node belongs to both the application tier and the database tier, since all servers are contained on that single node. In a multi-node system, each node supports one or more servers (or services), and belongs to one or both tiers. If the node provides any of the application tier services, including Forms services, Web services, or Batch Processing services (Concurrent Processing server), then there is an APPL_TOP on the node, it belongs to the application tier, and is considered an application tier server node. If the node contains the database server, which means that there is an Oracle10g ORACLE_HOME and the Applications database instance on the node, then the node belongs to the database tier, and is considered a database server node. Let's analyze a common configuration where the database server and the Concurrent Processing server exist on one node (Node 1), and the other servers exist on a second node (Node 2). Since Node 1 contains both an application tier server (Concurrent Processing server) and the database server, Node 1 belongs to both the database tier and the application tier. Since Node 2 contains only application tier servers, Node 2 belongs only to the application tier. Back to FAQ List 4) How do I configure AutoConfig for a multi-node system? Answer: AutoConfig is enabled by default on every application tier node in Oracle E-Business Suite Release 12. Back to FAQ List 5) What user do I log in as to use AutoConfig in a typical multi-node system? Answer: For nodes running Windows, there is only one user that owns both the application tier servers and the database server, so you would log in as that user. For nodes running UNIX (including Linux), if you want to configure the application tier servers, log in as the user that owns the application tier servers (often referred to as the applmgr user). If you want to configure the database server, log in as the user that owns the database server (often referred to as the oracle user). Note that the applmgr user and the oracle user can be the same user, or different users. Back to FAQ List 6) What does the term "<Context_Name>" mean? Answer: The "<Context_Name>" is the logical name for your context repository. The default value for <Context_Name> is <SID>_<hostname>. Back to FAQ List 7) What is the environment variable $INST_TOP? Answer: New in Release 12, the Instance Top ($INST_TOP) is the central location for all the instance-specific information. The location is pointed to by the context variable s_config_home. Back to FAQ List 8) What are the basic components of AutoConfig? Answer:
Components Applications Context Location On the application tier: <INST_TOP>/appl/admin On the database tier: <RDBMS ORACLE_HOME>/appsutil Description An XML repository (<CONTEXT_NAME>.xml) contains information specific to that Applications instance. Do not manually update this file!
On the application tier: <PROD_TOP>/admin/template For example: <AD_TOP>/admin/template <FND_TOP>/admin/template On the database tier: <RDBMS ORACLE_HOME>/appsutil/template
Include named tags which are replaced with instance-specific information from the Applications Context. There is one template file for each configuration file. For example: apps_nt.conf apps_ux.conf
On the application tier: <PROD_TOP>/admin/driver For example: <AD_TOP>/admin/driver/adtmpl.drv <FND_TOP>/admin/driver/fndtmpl.drv On the database tier: <RDBMS ORACLE_HOME>/appsutil/template
Used by AutoConfig to list the AutoConfig Template Files, their destination locations, and the commands to be executed, for example, the commands to update profile options. Every Product Top contains its own AutoConfig File Driver.
AutoConfig Scripts
https://support.oracle.com/CSP/main/article?cmd=show&type=NOT&doctype=WHIT... 2010/10/25
Using AutoConfig to Manage System Configurations with Oracle Applications Rel... Page 13 of 20
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.
Location On the application tier: <INST_TOP>/admin/scripts On the database tier: <RDBMS ORACLE_HOME>/appsutil/ scripts/<CONTEXT_NAME>
Description A wrapper script that calls adconfig.sh/adconfig.cmd. Instantiates template files with values specific to the instance (taken from the Applications for the application tier and the database context for the database tier). Updates configuration files and profile options.
adconfig.sh adconfig.cmd
A wrapper script that calls adconfig.pl. In earlier versions of AutoConfig adconfig.sh/ adconfig.cmd used to call the Java API to start AutoConfig.
adconfig.pl
adchkcfg.sh adchkcfg.cmd
Generates a report that highlights differences between the original config files and AutoConfiggenerated config files. The report is named cfgcheck.html. It is located under: On the application tier: <INST_TOP>/admin/ /out/<MMDDhhmm> On the database tier: <RDBMS ORACLE_HOME>/appsutil/out/ <CONTEXT_NAME>/<MMDDhhmm>
On being prompted for the context file to be retrieved, select the option of retrieving the applications tier context file that has been lost and retrieve it to the default location specified by the script. The above command can be used only when the <INST_TOP> is still intact. In case the <INST_TOP> has also been lost accidentally, the applications tier context file may be retrieved as follows: Execute the following command on the database tier:
perl <ORACLE_HOME>/appsutil/clone/bin/adclonectx.pl retrieve
On being prompted for the context file to be retrieved, select the option of retrieving the applications tier context file that has been lost. While confirming the location for the context file, set it to any existing directory with write permission.
https://support.oracle.com/CSP/main/article?cmd=show&type=NOT&doctype=WHIT... 2010/10/25
Using AutoConfig to Manage System Configurations with Oracle Applications Rel... Page 14 of 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:
perl <ORACLE_HOME>/appsutil/clone/bin/adclonectx.pl retrieve
On being prompted for the context file to be retrieved, select the database tier context file and retrieve it to the default location specified by the script. Back to FAQ List
Back to FAQ List 2) Which files and profile options are changed when I run AutoConfig? Answer: Run the adchkcfg utility to get an HTML report that lists all the files and profile options that get changed when you run AutoConfig. For instructions on how to run the adchkcfg utility and a discussion about the report that the utility generates, refer to Section 5.3. Back to FAQ List 3) Where is the log file located that AutoConfig creates? Answer: The log file that AutoConfig creates is located at: On the application tier: <INST_TOP>/admin/log/<MMDDhhmm>/adconfig.log On the database tier: <RDBMS ORACLE_HOME>/appsutil/log/<CONTEXT_NAME>/<MMDDhhmm>/adconfig.log where: <MMDDhhmm> = (month, day, hour, and minute of the AutoConfig run) Back to FAQ List 4) Which directories based on the <Context_Name> will AutoConfig create? Answer: AutoConfig creates the following directories based on the <CONTEXT_NAME>: Instance Top : <INSTALL_BASE>/inst/apps/<CONTEXT_NAME> Back to FAQ List
5) What is the location of control scripts that are used to start the services?
Answer: The control scripts for starting/stopping the services are located at <INST_TOP>/admin/scripts. This location is also pointed by an environment variable $ADMIN_SCRIPTS_HOME.
Back to FAQ List 6) How can I roll back an AutoConfig session? Answer: All backup configuration files from each AutoConfig session are stored in: On the application tier: <INST_TOP>/admin/out/<MMDDhhmm> On the database tier: <RDBMS ORACLE_HOME>/appsutil/out/<CONTEXT_NAME>/<MMDDhhmm> where: <MMDDhhmm> = (month, day, hour, and minute of the AutoConfig run) You can run restore.sh (UNIX) or restore.cmd (Windows) to roll back an AutoConfig session. Back to FAQ List
9.4. Customizations
1) How do I preserve customizations to an AutoConfig-maintained environment? Answer: Refer to Section 4 for details on how to implement customizations. Back to FAQ List 2) What are customizable templates? Answer: These are templates to which customizations can be added and recognized by AutoConfig. Back to FAQ List 3) What are non-customizable templates? Answer: These are templates that do not support customizations. Any customizations done on these templates are not recognized by AutoConfig.
https://support.oracle.com/CSP/main/article?cmd=show&type=NOT&doctype=WHIT... 2010/10/25
Using AutoConfig to Manage System Configurations with Oracle Applications Rel... Page 15 of 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 is a non-customizable template. If the "LOCK" keyword is not seen, then that template can be customized. For example:
fnd admin/template apps_conf_1013.tmp INSTE8 <s_ora_config_home>/10.1.3/Apache/Apache/conf apps.conf 600 LOCK
Therefore, apps_conf_1013.tmp is a non-customizable template. Back to FAQ List 5) What is the mechanism for sending the Applications user name and password to a new custom template? Answer: In Release 11i, the APPS user name and password were passed as command line arguments to the calling script. In Release 12, the APPS user name and password are passed via standard input instead, to increase security. Back to FAQ List 6) What do I do when a patch or Oracle documentation instructs me to manually modify an AutoConfig-maintained file? Answer: Log a Service Request with Oracle Support to request incorporation of the modification in the relevant AutoConfig template. Back to FAQ List
https://support.oracle.com/CSP/main/article?cmd=show&type=NOT&doctype=WHIT... 2010/10/25
Using AutoConfig to Manage System Configurations with Oracle Applications Rel... Page 16 of 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 <AD_TOP>/bin/adgentns.pl contextfile=<CONTEXT_FILE> -removeserver
Back to FAQ List 7) How do I deregister a database tier from the Net Services Topology Data Model? Answer: To deregister the current database tier from the Net Services Topology Data Model, invoke the following command:
perl <RDBMS ORACLE_HOME>/appsutil/bin/adgentns.pl contextfile=<CONTEXT_FILE> -removeserver
Back to FAQ List 8) When do I need to purge the complete Net Services Topology Data Model? Answer: You need to purge the complete Net Services Topology Data Model when the database name is changed as a result of a database upgrade or migration. Back to FAQ List 9) How do I purge the complete Net Services Topology Data Model? Answer: To purge the complete Net Services Topology Data Model, run the following command:
perl <AD_TOP>/bin/adgentns.pl contextfile=<CONTEXT_FILE> -removesystem
Back to FAQ List 10) How do I seed the Net Services Topology Data Model after purging it? Answer: See Question 4 above, "How do I seed the Net Services Topology Data Model?". Back to FAQ List 11) I want to deregister an application tier or a database tier from the Net Services Topology Data Model. I can't use the adgentns.pl script because I already decommissioned the tier or removed the context file. How can I deregister the tier? Answer: In this case you can use the PL/SQL API. Perform the following steps in the order listed: 1. Locate the system name: The system name is the database name Obtain it by running the following SQL query:
select DB_NAME from FND_DATABASES;
2. Locate the server name corresponding to the tier in question: Run this SQL query on the database tier:
select NAME, SERVER_TYPE from FND_APP_SERVERS, FND_NODES where FND_APP_SERVERS.NODE_ID = FND_NODES.NODE_ID and SERVER_TYPE='DB' and FND_NODES.NODE_NAME=upper('hostname');
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');
Back to FAQ List 12) I want to purge the complete Net Services Topology Data Model. I can't use the adgentns.pl script because I removed the relevant context file. How can I purge the Data Model? Answer: In this case, you can use the PL/SQL API. Perform the following steps in the order listed: Locate the System Name: The System name is the database name Obtain it by running the following SQL query:
select DB_NAME from FND_DATABASES;
https://support.oracle.com/CSP/main/article?cmd=show&type=NOT&doctype=WHIT... 2010/10/25
Using AutoConfig to Manage System Configurations with Oracle Applications Rel... Page 17 of 20
Back to FAQ List 13) How do I configure AutoConfig to generate failover aliases? Answer: To generate the failover aliases, update the database tier context variable s_alt_service_instances. You can specify a comma-separated description list of "servicename:instance" to manage connect time failover. For example:
'SERVICE_NAME:INSTANCE_NAME1,SERVICE_NAME:INSTANCE_NAME2'
This will generate a TNS alias in the tnsnames.ora file that fails over to INSTANCE_NAME1 when the current instance is not available. If INSTANCE_NAME1 is not available, failover is to INSTANCE_NAME2 instead. To set up the failover listing, perform the following steps in the order listed: 1. Update the context variable s_alt_service_instances in the database tier context file, applying the failover rules as described above 2. Run AutoConfig on all database tiers 3. Run AutoConfig on all application tiers These steps will generate the failover TNS alias <INSTANCE_NAME>_FO with a description list as configured in s_alt_service_instances. Before you can use these aliases, you will have to set the two task variable s_tool_twotask. Check the question "For which database versions can I define failover aliases" for information about the availability of failover aliases on different database versions. Note: The generated alias <INSTANCE_NAME>_FO can only be used for failover. Back to FAQ List 14) For which database versions can I define failover aliases? Answer: You can generate failover aliases for all database versions that are 8.1.7.4 or higher. Oracle E-Business Suite Release 12 uses the Oracle 10g Release 2 database. Back to FAQ List
4) Does AutoConfig support spfiles? Answer: AutoConfig currently does not support spfiles. It only supports the init.ora file. Back to FAQ List 5) What steps do I need to follow to maintain my database connectivity when I migrate my database from one host/platform to another? Answer: Perform the steps in the order listed: Before the migration: 1. Deregister the database tier from the Net Services Topology Data Model. Refer to the question "How do I deregister a database tier from the Net Services Topology Data Model?" After the migration: 1. Reset the context variable s_apps_jdbc_connect_descriptor in the context file for the application tier to an empty string. 2. Update the context variables s_dbhost and s_dbport in the context file for the application tier to reflect the new values in the middle tier context file. Back to FAQ List 6) I migrated my database tier to a new host/platform, but the application tier still tries to connect to the old database. How can I fix this situation, so that the application tier connects to the new database? Answer: Your old database tier is still registered in the Net Services Topology Data Model. Perform the following steps: You have to clean up the data model by following the steps described in the question: "How do I purge the complete Net Services Topology Data Model?". Perform the step described in the question: "How do I seed the Net Service Topology Data Model?" Back to FAQ List
https://support.oracle.com/CSP/main/article?cmd=show&type=NOT&doctype=WHIT... 2010/10/25
Using AutoConfig to Manage System Configurations with Oracle Applications Rel... Page 18 of 20
9.10. Troubleshooting
1) What should I do if my AutoConfig script exits with non-zero status? Answer: If AutoConfig exits with non-zero status, open the adconfig.log and check for the reported errors: Errors in the instantiation phase: Check to see if the template files listed in the error summary exist in your file system. If they do not exist, there may be a problem with the AutoConfig file driver of the product. Report the problem to Oracle Support. If the template files exist, check for permission issues. If you cannot fix the issue, report the problem to Oracle Support. Error encountered in the SETUP/PROFILE/APPLY phase: Check the adconfig.log file to see the reason for the failure. If you cannot fix the issue, report the problem to Oracle Support.
https://support.oracle.com/CSP/main/article?cmd=show&type=NOT&doctype=WHIT... 2010/10/25
Using AutoConfig to Manage System Configurations with Oracle Applications Rel... Page 19 of 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
AutoConfig places the instantiated configuration file in this directory Name of the instantiated configuration file AutoConfig generates the configuration file with the provided UNIX-style permissions
AutoConfig would instantiate the template file <MY_TOP>/admin/template/myTemplate.txt and generate the configuration file myConfiguration.txt into the Portal directory (the Portal directory is instantiated from <s_pt>) with 660 (read and write for user and group) permission. No supplementary information is available at present.
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:
export PERL5LIB=<ORACLE_HOME>/perl/lib/5.10.0:<ORACLE_HOME>/perl/site_perl/5.10.0:<ORACLE_HOME>/appsutil/perl
Change Log
Date July 15, 2010 Jun 10, 2010 Feb 17, 2010 Dec 31, 2009 Nov 04, 2009 Oct 19, 2009 Sep 10, 2009 Aug 28, 2009 May 14, 2009 Apr 30, 2009 Description Added reference to the R12.TXK.B.DELTA.3 (Patchset 8919489). Added reference to the R12.TXK.A.DELTA.7 (Patchset 9386653). Added reference to the R12.TXK.B.DELTA.2 (Patchset 7651166). Added appendix regarding setting the PERL5LIB variable on the database tier. Added information about the new CheckConfig section. Enhanced Section 3.2 to have a step for running AutoConfig on a newly created Oracle Home. Modified Section 3.2 Step 3 to clarify the minimum supported jre version. Added note about TXK AutoConfig Template patch not being released for 12.1.1 as of now. Corrected typos in Section 2 Restructured the doc Enhanced the Table of Contents Restructured and split Section 2 (System Configuration and Maintenance) into Sections 2 and 3. Moved the System Configuration commands into Section 7. Moved the AutoConfig tools list into Section 1. Merged the content of Section 6 (AutoConfig on Database tier) into the new section on Patching AutoConfig (Section 3). Renamed Section 3 (Application Services Management) and moved it to Section 7. Apr 09, 2009 Mar 20, 2008 Dec 23, 2008 Nov 19, 2008 July 17, 2008 June 19, 2008 Jan 21, 2008 Added a new section for the AutoConfig features and tools. Added a clarification note regarding OCM service management Updated links to the AutoConfig patch to point to 12.0.6 (R12.TXK.A.DELTA.6) patchset. Removed links to 12.0.2 (R12.TXK.A.delta.2) patchset. Moved the FAQ on spfiles to a generic section. Added Section 6, "AutoConfig on the Database tier". Updated references to the latest AutoConfig Patch.
https://support.oracle.com/CSP/main/article?cmd=show&type=NOT&doctype=WHIT... 2010/10/25
Using AutoConfig to Manage System Configurations with Oracle Applications Rel... Page 20 of 20
Dec 11, 2007 Nov 06, 2007 Oct 18, 2007 Oct 03, 2007 July 20, 2007 July 19, 2007 May 15, 2007 Feb 19, 2007 Jan 24, 2007
Added a known issue for Windows Itanium customers. Added FAQ regarding RAC spfiles. Updated references to the latest AutoConfig Patch. Modified instructions for setting default value of custom product top. Added a known issue. Added back references to the latest AutoConfig Patch. Removed references to the latest AutoConfig patch until next patch release. Modified the name of the custom context variable. Also modified the FAQ on retrieval of context file. Initial creation.
Note 387859.1 by Oracle E-Business Suite Development Copyright 2007, 2008 Oracle Corporation
Attachments CheckCfgDB.GIF (58.91 KB) CheckCfgFS.GIF (59 KB) CtxVarInf.GIF (43.21 KB) ProfilerDetails.GIF (45.43 KB) ProfilerSummary.GIF (39.47 KB)
Related
Products Oracle E-Business Suite > Applications Technology > Technology Components > Oracle Applications Technology Stack Keywords CONFIGURATION; AUTOCONFIG
Back to top
https://support.oracle.com/CSP/main/article?cmd=show&type=NOT&doctype=WHIT... 2010/10/25