R12 d49656 gc10-apps dba 16
Download as PPT, PDF1 like1,044 views
AutoConfig is a tool that centralizes and simplifies Oracle Applications configuration management. It works with Oracle Applications Manager to edit the Applications context file, which contains all configuration parameters. AutoConfig then generates configuration files and updates profiles by reading templates and the Applications context. Running AutoConfig propagates changes to both the application and database tiers. Its logs and rollback files allow monitoring runs and restoring previous configurations.
R12 d49656 gc10-apps dba 16
- 1. AutoConfig
- 2. Objectives At the end of this module, you should be able to do the following: Describe the Applications context Describe AutoConfig Identify the scripts used by AutoConfig Run AutoConfig to configure an Oracle Applications system Update Applications context parameters Restore Applications context parameters Roll back an AutoConfig session Run AutoConfig in test mode
- 3. Module Overview This module introduces the AutoConfig utility and the process of configuring the Oracle Applications system This module consists of the following topics: Context Files Introduction to AutoConfig AutoConfig Features AutoConfig Operation Running AutoConfig from Oracle Applications Manager Using the Support Cart Restoring a Previous Configuration Comparing Configurations
- 4. Context Files Rapid Install captures all the configuration parameters associated with your installation in two context files Parameters for the application tier – the APPL_TOP and the Applications technology stack – are stored in the Applications context file Parameters for the database tier are stored in the database context file
- 5. Context Files You can edit the existing configuration parameters using Oracle Applications Manager (OAM) AutoConfig When you save the new parameters, OAM stores them in the OAM schema and automatically updates (synchronizes) the context files You must then run the AutoConfig script to update the system configuration files and database profiles with the new parameters
- 6. Benefits of the Context Files By describing all the services for a particular APPL_TOP in a single Applications context, services can be started up and shut down easily Use of a single Applications context allows services to be added or removed without having to modify the core startup/shutdown mechanism There are fewer files for Oracle Development to maintain and support, improving robustness and reliability across Oracle Applications
- 7. Applications Context File The Applications context file: Is called <CONTEXT_NAME>.xml Is in <INST_TOP>/apps/<CONTEXT_NAME>/appl/admin for each node of the application tier Contains configuration information for the application tier of a specific Oracle Applications system Is used to configure all the other files necessary to set up and make available a particular Oracle Applications system
- 8. Database Context File The database context file: Is called <CONTEXT_NAME>.xml Is in <RDBMS_ORACLE_HOME>/appsutil/ for the database tier Contains configuration information for the database tier of a particular Oracle Applications system
- 9. Benefits of the Context Files All Applications specific configuration information is stored in the two context files, instead of in numerous files located in directories distributed across the system Advantages of this strategy include: Avoids the need for repeated configuration information The APPL_TOP environment is readily described in a single file The database environment is readily described in a single file Easier to integrate into the process of cloning new systems, as opposed to editing numerous files
- 10. Benefits of the Context Files The XML format is easier to read and use than a variety of formats in individual configuration files Configuration information is represented in a platform-independent format The context file is able to handle Windows registry information
- 11. Benefits of the Context Files Supports shared application tier file system Allows you to synchronize multiple nodes
- 12. Introduction to AutoConfig The main AutoConfig script: Is a tool that centralizes and simplifies Oracle Applications configuration management Removes the need to make manual updates to configuration files, which can be tedious and prone to error if multiple files are involved Works in conjunction with OAM to edit and update system configuration Works in the same way on all platforms
- 13. AutoConfig and the Applications Context All the information required for configuring an Oracle Applications instance is collected in a repository, called the context file AutoConfig maintains the context file Details stored in the context file include hostname, domain name, directory structure, and port numbers used The OAM AutoConfig editor is used to make changes to the context file
- 14. AutoConfig and the Applications Context The AutoConfig script uses information from the context file to generate all Applications configuration files and update database profiles By supplying the configuration information in a standard location, AutoConfig simplifies procedures such as: Upgrading an Applications technology stack component Starting and stopping Oracle Applications services
- 15. AutoConfig Template Files The AutoConfig script uses template files to determine the basic settings that are needed There is one template file for each configuration file Different versions of the template files exist for UNIX and Windows The template files are located in the <PROD_TOP>/admin/template directories For example: <AD_TOP>/admin/template <FND_TOP>/admin/template
- 16. AutoConfig Tasks AutoConfig instantiation (creation) activities include: Instantiation of a configuration file to be used at runtime Instantiation of a SQL script that will set profile option values that can be either site or instance-specific Instantiation of a shell script or Windows command file that will run the just created SQL script via SQL*Plus, and then execute the shell script Instantiation of scripts to start up and shut down services such as Java server processes Script
- 17. AutoConfig Operation The main AutoConfig script is adautocfg.sh (UNIX) or adautocfg.cmd (Windows) Located in: <INST_TOP>/admin/scripts (Application tier) <RDBMS ORACLE_HOME>/appsutil/scripts/<CONTEXT_NAME> ( Database tier) This script calls another script <AD_TOP>/bin/adconfig.sh (UNIX) <AD_TOP>\bin\adconfig.cmd (Windows) adautocfg.sh adconfig.sh
- 18. AutoConfig Operation AutoConfig creates configuration files by reading several different types of file from various locations:
- 19. Running AutoConfig You must run AutoConfig for your system to make any context file updates to your system Doing so generates the new configuration files for the associated technology stack AutoConfig uses the parameters stored in the context file and system configuration templates to create new process control scripts and update system profiles Script
- 20. Running AutoConfig 1. Log on as the appropriate user and set the environment 2. Stop all server processes 3. Run AutoConfig on the application tier to update configuration and profiles on the application tier 4. Run AutoConfig on the database tier to update configuration and profiles on the database tier 5. Start all server processes
- 21. Running AutoConfig - Application Tier To start AutoConfig on the application tier: UNIX: AutoConfig prompts for the APPS password Windows: AutoConfig does not prompt for the APPS password; you must supply it on the command line $ <INST_TOP>/admin/scripts/adautocfg.sh C:\> <INST_TOP>\admin\scripts\adautocfg.cmd <APPS password>
- 22. Running AutoConfig - Database Tier To Start AutoConfig on the database tier: UNIX: AutoConfig prompts for the APPS password Windows: AutoConfig does not prompt for the APPS password; you must supply it on the initial command line $ <RDBMS_ORACLE_HOME>/appsutil/scripts/ \ <CONTEXT_NAME>/adautocfg.sh C:\> <RDBMS ORACLE_HOME>\appsutil\scripts\ <CONTEXT_NAME>\adautocfg.cmd <APPS password>
- 23. AutoConfig Log Files AutoConfig log files are stored under: Application tier: <INST_TOP>/admin/log/<MMDDhhmm>/ Database tier: <RDBMS ORACLE_HOME>/appsutil/log/<CONTEXT_NAME>/ <MMDDhhmm> There is one log file per AutoConfig session, containing detailed information about every action that AutoConfig performed in that run Log
- 24. Rolling Back an AutoConfig Session The rollback script and all backup configuration files from each AutoConfig session are stored in: Application Tier: <INST_TOP>/admin/out/<MMDDhhmm> Database Tier: <RDBMS_ORACLE_HOME>/appsutil/out/<CONTEXT_NAME>/ <MMDDhhmm> where:<MMDDhhmm> = (month, day, hour, minute of AutoConfig run)
- 25. Rolling Back an AutoConfig Session To roll back the effects of an AutoConfig run, go to the relevant directory and run the appropriate restore script: UNIX: Windows: $ restore.sh D:\> restore.cmd
- 26. Editing AutoConfig-Managed Configuration Files All AutoConfig generated configuration files contain the following header information You should not manually edit these files Use OAM AutoConfig to edit parameters in the Applications Context, then run AutoConfig to regenerate the configuration files
- 27. Running AutoConfig In Test Mode Running the AutoConfig script to propagate changes overwrites the existing configuration files This process may overwrite any customizations you made to the configuration files To prevent any unwanted changes, use the test (check) mode to determine the impact of running AutoConfig, without actually making any updates
- 28. Running AutoConfig in Test Mode – Application Tier To run AutoConfig in test mode on the application tier, run one of the following commands: UNIX: Windows: AutoConfig prompts for the location of the Applications context file and the APPS password $ <AD_TOP>/bin/adchkcfg.sh C:\> <AD_TOP>\bin\adchkcfg.cmd
- 29. Running AutoConfig in Test Mode – Database Tier To run AutoConfig in test mode on the database tier: UNIX: Windows: AutoConfig prompts for the location of the database context file and the APPS password $ <RDBMS_ORACLE_HOME>/appsutil/bin/adchkcfg.sh C:\> <RDBMS_ORACLE_HOME>\appsutil\bin\ adchkcfg.cmd
- 30. Running AutoConfig in Test Mode – AutoConfig Configuration Report The AutoConfig test mode script produces a configuration report that shows the changes the AutoConfig script would have made The configuration report, cfgcheck.html, is written to: On the application tier: <INST_TOP>/admin/out/<MMDDhhmm> On the database tier: <RDBMS_ORACLE_HOME>/appsutil/log/ <CONTEXT_NAME>/<MMDDhhmm>
- 31. AutoConfig test mode script example output (tail): An example of cfgcheck.html report contents is shown on the next slides Running AutoConfig in Test Mode – AutoConfig Configuration Report (cont.)
- 32. AutoConfig Configuration Report – Example
- 33. AutoConfig Configuration Report – Example (cont.) AutoConfig test mode script example:
- 34. Running AutoConfig from Oracle Applications Manager
- 35. Running AutoConfig from Oracle Applications Manager
- 36. Running AutoConfig from Oracle Applications Manager
- 43. Using the Support Cart
- 44. Using the Support Cart
- 45. Using the Support Cart
- 46. Restoring a Previous Configuration To view configuration history and restore a previous configuration: Access AutoConfig via OAM View configuration history Select the configuration parameters Restore configuration
- 47. Restoring a Previous Configuration
- 48. Restoring a Previous Configuration
- 50. Module Summary In this module, you should have learned how to do the following: Describe the Applications Context Update Applications Context parameters Restore Applications Context parameters Describe AutoConfig Run AutoConfig to configure your Oracle Applications system Roll back an AutoConfig session Identify the control scripts created by AutoConfig Run AutoConfig in test mode
- 51. Module Discussion Describe the purpose and content of the Applications Context What are some benefits of the Applications context? Describe the benefits of the Support Cart Outline the procedure to update an Applications context parameter Describe the primary benefits and usage of AutoConfig How are template files used by AutoConfig? What is the process of updating the application tier control files?
- 52. Module Practice Editing Applications context Configuring your system Rolling back an AutoConfig session Restoring a previous configuration Running AutoConfig in test mode
Editor's Notes
- #2: ILT Schedule: Timing Topic 60 minutes Lecture 60 minutes Practice 120 minutes Total
- #3: <Course name> <Lesson number> -
- #4: <Course name> <Lesson number> -
- #5: <Course name> <Lesson number> -
- #6: <Course name> <Lesson number> -
- #7: <Course name> <Lesson number> -
- #8: <Course name> <Lesson number> -
- #9: <Course name> <Lesson number> -
- #10: <Course name> <Lesson number> -
- #11: <Course name> <Lesson number> -
- #12: <Course name> <Lesson number> -
- #13: <Course name> <Lesson number> - AutoConfig A fresh installation of Oracle E-Business Suite Release 12 includes AutoConfig as a standard (and required) configuration management tool.
- #14: <Course name> <Lesson number> -
- #15: <Course name> <Lesson number> -
- #16: <Course name> <Lesson number> -
- #17: <Course name> <Lesson number> -
- #18: <Course name> <Lesson number> -
- #19: <Course name> <Lesson number> - AutoConfig Operation AutoConfig template files are used as the starting point for creating site-specific configuration files. AutoConfig evaluates the context variables in a template file, determines the actual values required, and creates a configuration file with these values substituted. This process, described in more detail later in this chapter, is called instantiation. There is one template file for each configuration file. Template files are located in the various <PROD>_TOP/admin/template directories on the application tier, and in the <RDBMS_ORACLE_HOME>/appsutil/template directory on the database tier. AutoConfig driver files are used to list the corresponding template files and locations, and specify the commands to be executed. For example, the commands might update profile options. Driver files are located in each <PROD>_TOP/admin/driver directory on the application tier, and in the <RDBMS_ORACLE_HOME>/appsutil/template directory on the database tier. AutoConfig configuration files, such as httpd.conf, are created as a result of AutoConfig instantiating the corresponding template files. Configuration files contain values corresponding to the settings specified for a particular site. After AutoConfig has been run, numerous configuration files will have been created in various directories.
- #20: <Course name> <Lesson number> -
- #21: <Course name> <Lesson number> -
- #22: <Course name> <Lesson number> - Running AutoConfig – Application Tier Instructor Note: On Windows, a command is entered as a single line of text, which wraps to the next screen line if needed.
- #23: <Course name> <Lesson number> - Running AutoConfig – Database Tier Instructor Note: The \\ (backslash) character on UNIX denotes that the command is continued on the following line. There is no equivalent on Windows.
- #24: <Course name> <Lesson number> - AutoConfig Log Files Log file directories are named <MMDDhhmm>, according to the month, day, hour, and minute of the AutoConfig run.
- #25: <Course name> <Lesson number> - Rolling Back an AutoConfig Session Each execution of AutoConfig creates a rollback script in case you need to revert to the previous configuration settings.
- #27: AutoConfig Created Configuration Files All AutoConfig generated configuration files have the header information seen in this slide. You should not manually edit these files. Use OAM AutoConfig to edit parameters in the Applications Context, then run AutoConfig to regenerate the configuration files with the updated information.
- #28: <Course name> <Lesson number> - AutoConfig - Test Mode The AutoConfig test mode script, adchkcfg.sh (UNIX) or adchkcfg.cmd (Windows), is located in <AD_TOP>/bin on the application tier and in <RDBMS ORACLE_HOME>/appsutil/bin on the database tier. This utility generates a report that highlights differences between existing configuration files and the new ones that AutoConfig will generate. The report is called cfgcheck.html. Running adchkcfg.sh is useful both in carrying out a test run before a planned environment change is made, and when investigating problems.
- #29: <Course name> <Lesson number> -
- #30: <Course name> <Lesson number> -
- #31: <Course name> <Lesson number> - AutoConfig Configuration Report <MMDDhhmm> represents the month, day, hour, and minute of the AutoConfig test mode script session.
- #32: <Course name> <Lesson number> -
- #33: <Course name> <Lesson number> -
- #34: <Course name> <Lesson number> -
- #35: <Course name> <Lesson number> - Accessing OAM The AutoConfig feature of Oracle Applications Manager (OAM) is used to update and manage the context files. Log in to Oracle Applications from a suitable account.
- #36: <Course name> <Lesson number> - Accessing OAM Click on Oracle Applications Manager (OAM).
- #37: <Course name> <Lesson number> - Accessing AutoConfig The OAM Dashboard appears. Click the Site Map tab. OAM displays a list of available links in the site. The AutoConfig link is located under the System Configuration heading of the Administration tab. Click on AutoConfig.
- #38: <Course name> <Lesson number> - OAM AutoConfig OAM displays the main AutoConfig page. For each node, the following information is shown: Name – shows the nodename Host – shows the hostname Last Synchronized Date – indicates when the database values and file values were last synchronized. Last Updated Date – indicates when the values in the database was last updated. Tier – shows the tier (database or Applications) for which the context file contains parameters. Synchronized – indicates whether the file and the system have been synchronized Node status – indicates whether the node is online. View – displays the context file Show History – displays history of changes made to the context file Edit Parameters – opens the Edit Parameters page
- #39: <Course name> <Lesson number> - OAM AutoConfig Click on the name of the node or the name of the host to filter the list of information. Expand the Details column for your selection by clicking on the plus (+) sign. AutoConfig displays information about the version, creation date, path of the file, and name of the user who last made updates. The Status information corresponds to the Synchronized column value. ‘Write succeeded’ indicates that the synchronization between the OAM database and the context file was successful. Click on Edit Parameters to see the existing configuration parameters grouped by these categories: Global, System, Local, Environments, OA_Ports, OA_Services, and Custom.
- #40: <Course name> <Lesson number> - Edit Parameters Page The initial Parameters page displays existing Global parameters. Information shown on all parameters pages includes: variable title, internal name (OA_VAR), change status indicator, value, and a short description. Clicking a category link displays the parameters associated with that category.
- #41: <Course name> <Lesson number> - Edit Parameters Page For example, click the System tab to see the parameters associated with Oracle Applications system. You can also search for a specific parameter by entering its title (name), OA_ VAR (internal name), value, or description in the Search field. Choose the appropriate group of parameters and make necessary changes in the Value field. Click Save.
- #42: <Course name> <Lesson number> - Confirmation Page AutoConfig displays a confirmation page and provides a space for comments. It also displays the entire contents of the context file, including the changed values. Notice that values are displayed in groups of 25. Click the arrows to move forward and back through the pages. Click OK to save the changes. Oracle Applications Manager automatically stores the new values and updates the context file. After updating the context file, run the AutoConfig script to generate new system configuration files that are propagated with the new values.
- #43: <Course name> <Lesson number> - Confirmation Page AutoConfig reminds you to run the AutoConfig script to instantiate new configuration files and update the database profiles.
- #44: <Course name> <Lesson number> - Support Cart Many pages throughout OAM have an Add to Support Cart button. The Support Cart feature allows you to save Oracle Applications Manager pages with their data, and then zip them into a file to send to Oracle Support, who can then view your pages in the Oracle Applications Manager display format.
- #45: <Course name> <Lesson number> - Support Cart When you click the Add to Support Cart button, the page is added to the Support Cart. If you have filtered or sorted the data, your manipulated view is submitted.
- #46: <Course name> <Lesson number> - Support Cart To view the contents of the Support Cart, click on the Support Cart icon from any page. The Support Cart Contents page lists each page placed in the cart and its Application Name. You can filter the list by Page or Application Name. Click the View icon to view a page in a separate window. Click on Save Cart to save the contents to a zip file that you can send to Oracle Support. Any contents of the cart that have not been saved are automatically deleted when you log out of Oracle Applications Manager. To restore a saved cart, click Restore Cart to browse your directory for the saved cart. Select a cart file from the list displayed, or use the Browse button to select a file from the directory. Click Restore.
- #47: Restoring a Previous Configuration With OAM AutoConfig, you can view a history of system configuration parameters stored by OAM. You can display the current configuration or previous ones, and request a comparison between the current configuration and a previous one. If necessary, AutoConfig can restore a previous set of configuration parameters, if an update was made in error, or did not suit your business requirements.
- #48: <Course name> <Lesson number> - Restoring a Previous Configuration Click Show History in the AutoConfig initial page to access the Context File History page.
- #49: <Course name> <Lesson number> - Restoring a Previous Configuration The Context File History page lists other configurations stored in OAM. It shows the version number, last synchronized date, last update date, the user who last updated the configuration, and any comments for each configuration. You can delete a previous configuration from the database by selecting it and clicking the Delete button. To see a contrast between the current configuration and one that you have used in the past, select a previous version from the list and click Show Differences from Current Configuration.
- #50: <Course name> <Lesson number> - Comparing Configurations The Show Differences from Current Configuration page lists the parameters that differ in value between the previous configuration and the current one. To restore an individual value, select Restore Previous Value. This action replaces the value in the current configuration. On the next page you can enter comments regarding your change.
- #51: <Course name> <Lesson number> -
- #52: <Course name> <Lesson number> -
- #53: <Course name> <Lesson number> - Refer to Practice - Editing Applications Context [LAB4205Y] Refer to Practice - Modifying your System [LAB4207Y] Refer to Practice - Rolling Back an AutoConfig Session [LAB4208Y] Refer to Practice - Restoring a Previous Configuration [LAB4209Y] Refer to Practice - Running AutoConfig in Test Mode [LAB420AY]