ADADMIN UTILITY

ADADMIN UTILITY

In order to ensure that Oracle Applications system runs smoothly, we must perform routine maintenance tasks. We run maintenance tasks from the command line using AD Administration. Once we start this utility, it presents the tasks in menu form, grouped generally by type of activity you will perform. For example, the tasks associated with compiling and reloading Applications database entities are grouped on the same menu.

We can use AD Administration to complete some runtime tasks during or after an installation or upgrade, or any time thereafter.

On a broad level the tasks performed by adadmin can be categorized into database activities and Applications file system management tasks.

Similar to AutoInstall and AutoPatch, adadmin can run parallel workers for most database tasks and some filesystem tasks.

Preliminary Tasks before running Adadmin:

1.      Logging in as applmgr.

2.      Running the environment file.

3.      Verifying if ORACLE_HOME is set properly.

4.      Verifying if ORACLE_SID or TWO_TASK identifies the correct database.

5.      Ensuring that ORACLE_HOME/bin and AD_TOP/bin are in PATH.

6.      Shutting down concurrent managers when relinking certain files or performing certain database tasks.

7.      Ensuring sufficient temporary disk space.

Running Adadmin:

AD Administration asks you some initial questions.

1.      It confirms your APPL_TOP is correct.

Ex: APPL_TOP is set to /u01/oaprod/oaprodappl

2.      It asks for the name of the log file.

By default this is adadmin.log

3.      It asks if we want to receive an email message if adadmin encounters a failure.

4.      Some SQL scripts perform row set processing. Adadmin asks us to set the number of rows these scripts process.

5.      It asks us the type of files we currently have.

Ex: Do you currently have files used for installing or upgrading the database installed in this APPL_TOP [YES] ? YES *

Do you currently have Java and HTML files for HTML-based functionality installed in this APPL_TOP [YES] ? YES *

Do you currently have Oracle Applications forms files installed

in this APPL_TOP [YES] ? YES *

Do you currently have concurrent program files installed in this APPL_TOP [YES] ? YES *

6.      It asks us to confirm the database and database home directory.

7.      It asks for the SYSTEM password. It then determines the username for your Application Object Library user.

8.      It determines the AOL Schema from information in data dictionary and asks for the password of AOL schema.

9.      Adadmin determines other installation information.

ADADMIN MAIN MENU:

The main menu of adadmin presents you with the following six choices

AD Administration Main Menu
--------------------------------------------------

1. Generate Applications Files menu

2. Maintain Applications Files menu

3. Compile/Reload Applications Database Entities menu

4. Maintain Applications Database Entities menu

5. Change Maintenance Mode

6. Exit AD Administration

first two options are related to maintaining applications file system the second two options relate to database activities, the fifth option here is used to put the system in maintenance mode and bring it back from maintenance mode.

1.      Generate Applications Files:

If system users are having difficulty accessing messages, forms, or reports, you may be able to resolve the issue by generating the associated files. Or, when you apply a patch that adds or changes product functionality, you may want to generate the associated files after you apply the patch, instead of running the generate driver during the patching downtime. The generate files tasks may be performed on any server, as required.

Under the Generate Applications Files Menu you can perform the following tasks

Generate Applications Files
----------------------------------------

1. Generate message files

2. Generate form files

3. Generate report files

4. Generate graphics files

5. Generate product JAR files

6. Return to Main Menu

a)      Generate Message Files:

Oracle Applications uses these files to display messages. This task generates message binary files (extension .msb) from Oracle Application Object Library tables.

Caution: Run this task only when instructed to do so in a patch readme file, or by Oracle Support Services

b)      Generate form files: Generates executable Oracle form files (extension .fmx) from the binary forms definition files (extension .fmb). The definition files are located under AU_TOP, and the executable files are stored under each product’s directory.

c)      Generate report files: Generates the binary Oracle Reports report files (extension .rdf).

Adadmin Prompts for following information :

■ Ask for the number of workers and generate selected objects for selected products in parallel.

■ Display the current character set (from NLS_LANG) and ask if you want to generate form or report objects in this character set.

■ Ask if you want to regenerate Oracle Forms PL/SQL library files, menu files, and executable files. (Form files only.)

■ Ask for the products associated with the form or report objects.

■ Ask if you want to generate specific form or report objects for each selected product.

■ Display the current set of installed languages and ask if you want to generate form or report files in these languages.

■ Create a list of all objects to generate.

■ Display the list of objects to be generated. (Specific objects or all objects.)

d)     Generate Product JAR Files:

Generate Java archive (JAR) files whenever you upgrade the Developer technology stack or when recommended by Oracle Support Services. It signs JAR files (if on the Web server) and does the following:

■ Generates product JAR files in JAVA_TOP and copies them to APPL_TOP.

■ Generates other Java-related files under APPL_TOP and JAVA_TOP.

■ Recreates Java libraries (appsborg.zip and appsborg2.zip) under APPL_TOP and JAVA_TOP.

When you run the task, it prompts: Do you wish to force generation of all jar files? [No] If you choose No, it generates only JAR files that are missing or out-of-date. If you choose Yes, all JAR files are generated.

Note: If AD Administration displays a list of warnings or errors and objects that did not generate successfully and asks if you want to continue as if successful, review the log file to determine if the problems require attention. If you choose not to continue and restart your session at a later time, AD Administration attempts to regenerate only the files that did not generate successfully.

e)      Generate Graphics files:
This task generates Oracle graphics files for all installed languages. Extension of the file name like (*.ogd).

2.      Maintain Applications Files :

Certain maintenance tasks are required to keep your Applications files up to date. For example, you may need to copy product files to a central location or convert files in the APPL_TOP to another character set. These tasks are grouped on the Maintain Applications Files menu.

Under the Maintain Applications Files menu you can perform the following tasks

Maintain Applications Files
----------------------------------------

1. Relink Applications programs

2. Create Applications environment file

3. Copy files to destinations

4. Convert character set

5. Maintain snapshot information

6. Check for missing files

7. Return to Main Menu

a)      Relink Applications programs

Relinks Oracle Applications executable programs with the Oracle server libraries so that they function with the Oracle database. For each product, choose whether to link all executables or only specific ones.

Note: The default is to relink without debug information. Use the debug option only when requested to do so by Oracle Support Services.

b)     Copy files to destinations

Copies files from each product area to central locations where they can be easily referenced by non-Applications programs. This option uses revision-based copy logic to ensure that the destination file versions are the same as, or higher than, the source file versions.

Note: We recommend that you do not use the force option to overwrite existing files unless instructed by Oracle Support Services. Copying files with this option updates all JAR files. JInitiator then downloads required JAR files to each client again, causing runtime performance degradation.

The file types and their respective destinations are shown in the following table:

These files:                                               copied to (UNIX)

Java files                                                   $JAVA_TOP

HTML files                                                $OAH_TOP

Media files                                                 $OAM_TOP

Note: When this option is used to copy reports or graphics files, the default destination is under AU_TOP.

c)      Convert character set:

Prepares the files in the APPL_TOP for conversion to another character set, and then performs the conversion.

When you choose this option, AD Administration presents another submenu, which contains options for scanning your files in preparation for the conversion. The scan searches for exceptions — files that will have incomplete (lossy) conversions — so that you can fix potential problems before you actually convert the character set. Choose one of the following scan options.

1.       Scan the APPL_TOP for exceptions. Scans the APPL_TOP and creates three files in the admin\<SID>\out directory.

File                                                      Contents

admanifest_excp.lst               Lists files that will not be converted because of lossy conversion. admanifest.lst                             Lists files that can be converted.         

admanifest_lossy.lst                   Lists files with lossy conversions, including line by line detail.

Review the files listed in admanifest_excp.lst. Fix files that report lossy conversion before you convert the character set. Repeat this task until there are no entries in admanifest_excp.lst. If you need to see more detail, review admanifest_lossy.lst.

2.       Scan a CUSTOM directory for exceptions. Collects the same information as the first task, but scans custom Applications directories rather than the APPL_TOP directory.

3.       Convert character set. Run this task only if admanifest_excp.lst has no entries. It prompts you for the manifest file (admanifest.lst) created when you ran the scan option(s).

The utility backs up the product source files and the APPL_TOP/admin source files. It saves product files in the <PROD>_TOP directories in the format <prod>_ s_<char_set>.zip. It saves admin source files in the APPL_TOP/admin directory in the format admin_s_<char_set>.zip

d)     Maintain snapshot information:

There are two types of snapshots: APPL_TOP snapshots and global snapshots. An APPL_TOP snapshot lists patches and versions of files in the APPL_TOP. A global snapshot lists patches and latest versions of files in the entire Applications system (that is, across all APPL_TOPs).

Both APPL_TOP snapshots and global snapshots may be either current view snapshots or named view snapshots. A current view snapshot is created once and updated when appropriate to maintain a consistent view. A partial view snapshot allows you to synchronize only selected files from a current view. A named view snapshot is a copy of the current view snapshot at a particular time (not necessarily the latest current view snapshot) and is not updated.

Patch Wizard uses the information contained in the global current view snapshot to determine which patches have already been applied. AutoPatch uses the APPL_TOP current view snapshot to determine if all prerequisite patches have been applied to that APPL_TOP. Snapshot information is stored in the AD_SNAPSHOTS, AD_ SNAPSHOT_FILES, and AD_SNAPSHOT_BUGFIXES tables.

During a new installation, Rapid Install creates a current snapshot as a baseline. And, each time you run AutoPatch, it automatically creates a new (updated) snapshot so that the information is current as of the application of the patch.

Maintain Snapshot Information menu options :

■ List snapshots (stored in the system)

■ Update current view snapshot (full or partial APPL_TOP and global)

■ Create named snapshot (select a current view snapshot to copy and name)

■ Export snapshot to file (select one to export to a text file)

■ Import snapshot from (a text) file

■ Delete named snapshot (select a snapshot for deletion)

Maintain current view snapshot information: When you maintain a current view snapshot, you can choose to synchronize selected files — maintaining a partial snapshot — instead of synchronizing all files for the entire APPL_TOP. Use this option when you have copied only a few files to the APPL_TOP.

1.        Select the Update Current View Snapshot option from the Maintain Snapshot Information menu.

2.        From the Maintain Current View Snapshot Information menu, select one of the following options:

■ Update Complete APPL_TOP This is the original functionality of the Update Current View Snapshot option. It synchronizes all the files in your APPL_TOP.

■ Update JAVA_TOP only Synchronizes only the files in the JAVA_TOP. At the prompt, enter the path to the JAVA_TOP subdirectory where the files were copied. If the files were copied to more than one directory, press Enter. AD Administration scans the entire JAVA_TOP and updates the information in both the current view and the global view snapshots.

■ Update a <PRODUCT>_TOP Synchronizes only the files in a specific <PRODUCT>_TOP. Enter the product abbreviation, then provide the subdirectory information at the prompt. Enter the path to a single subdirectory in the <PRODUCT>_TOP. If the files were copied to more than one directory in the <PRODUCT>_TOP, press Enter. AD Administration scans the entire <PRODUCT>_TOP and updates the information in both the current and the global view snapshots.

e)      Check for Missing Files:

 Verifies that all files needed to run Oracle Applications for the current configuration are in the current APPL_TOP. Choose this task if you suspect there are files missing in your APPL_TOP.

3.  Compile/Reload Applications Database Entities:

To compile or reload database entities, choose the Compile/Reload Applications Database Entities Menu option from the AD Administration Main Menu.           

You run the tasks on this menu any time you need to compile or reload database objects. For example, after you upload new menu entries or apply a patch that changes the setup of flexfields. Run these tasks only on the node where the core AD technology directories (the administration server) are located.

Under the Compile/Reload Applications Database Entities menu you can perform the following tasks

Compile/Reload Applications Database Entities
---------------------------------------------------

1. Compile APPS schema

2. Compile menu information

3. Compile flexfields

4. Reload JAR files to database

5. Return to Main Menu

a)      Compile APPS schema

Spawns parallel workers to compile invalid database objects in the APPS schema.

Note: The need for a separate MRC schema has been removed in this release, as has the associated prompt to run Invoker Rights.

b)     Compile menu information

Compiles menu data structures. Choose this task after you have uploaded menu entries to the FND_MENU_ENTRIES table, or if Compile Security concurrent requests submitted from the Menus form (after changing menu entries) fail for any reason.

AD Administration asks if you want to force compilation of all menus. If you choose the default (No), only menus with changes are compiled. If you enter Yes, all menus are compiled. Compiling all menus is generally not advised.

c)      Compile flexfields

Compiles flexfield data structures in Oracle Application Object Library (FND) tables. Choose this task after you apply a patch that changes the setup of flexfields. Patches usually indicate when you should perform this step.

Flexfields automatically compile data when you use them for the first time, so running this task is not required. However, compiling flexfield data at a specific time (for example, when system use is low), rather than automatically at first use, can alleviate potential runtime performance issues.

d)     Reload JAR files to database

Reloads all appropriate Oracle Applications JAR files into the database. Choose this task if all Oracle Applications Java classes are removed from your database, for example, if the database Java Virtual Machine (JVM) is reloaded because of a corrupt database.

4. Maintain Applications Database Entities:

During normal system use, the integrity of your database can be compromised, for example through user error or after you apply a large patch. It’s a good idea to verify the integrity of database entities as a regular maintenance procedure, or whenever the behavior of your system indicates that database entities may have been corrupted.

Some tasks on this menu report on issues, or potential issues, with database entities, and others actually remedy the issues. Run these tasks only on the node where the core AD technology directories (the administration server) are located.

Under the Maintain Applications Database Entities menu you can perform the following tasks

Maintain Applications Database Entities
---------------------------------------------------

1. Validate APPS schema

2. Re-create grants and synonyms for APPS schema

3. Maintain multi-lingual tables

4. Check DUAL table

5. Maintain Multiple Reporting Currencies schema

6. Return to Main Menu

a)      Validate APPS schema

Verifies the integrity of the APPS schema. It produces a report named <APPS schema name>.lst that lists issues and potential issues, grouped by the action required:

■ Issues you MUST fix (not specific to the APPS schema)

■ Issues you MUST fix (specific to the APPS schema)

■ Issues you may want to address (specific to the APPS schema).

 The report is located in $APPL_TOP/admin/<SID>/out (UNIX), where <SID> is the value of the ORACLE_SID or TWO_TASK variable, or in %APPL_ TOP%\admin\<SID>\out (Windows), where <SID> is the value of the LOCAL variable. Each section of the file contains instructions for resolving the issues that are listed. Most issues can be fixed by either compiling invalid database objects or recreating grants and synonyms.

b)     Re-create grants and synonyms for APPS schema

This task recreates grants and synonyms for the Oracle Applications public schema (APPLSYSPUB), recreates grants on some packages from SYSTEM to APPS, and spawns parallel workers to recreate grants and synonyms linking sequences and tables in the base schemas to the APPS schema.

Typically, you run this task after the Validate APPS schema task has reported issues with missing grants and synonyms.

c)      Maintain multi-lingual tables

Run this task after you add a language. It prompts you for the number of workers, then updates all multilingual tables.

d)     Check DUAL table

Some Oracle Applications products must access the DUAL table. It must exist in the SYS schema and contain exactly one row. This tasks verifies the existence of this table and the single row.

e)      Maintain Multiple Reporting Currencies schema

It invokes PL/SQL packages which maintain database objects for these features. (See admntmls.pls and admntmcr.pls in $AD_TOP/admin/sql)

MRC and MLS are both implemented using "adjunct APPS schemas", meaning a
complete copy of the objects in each APPS schema is replicated (and enhanced,
in some cases) into an APPS_MRC and/or APPS_MLS schema. Whenever a
change is made to an APPS schema, the modifications must be reflected in the
adjunct schemas; otherwise, MRC and MLS functions may fail.

This task is only displayed on the Database Objects menu if you have
Multilingual (MLS) or Multiple Reporting Currency (MRC) functionality currently
installed.

5. Change Maintenance Mode:

Maintenance mode controls the system downtime period by managing user logons. You toggle maintenance mode from enabled to disabled from the Change Maintenance Mode menu.

Under the Change Maintenance Mode you can do the following

Change Maintenance Mode
----------------------------------------

Maintenance Mode is currently: [Disabled].


Maintenance mode should normally be enabled when patching Oracle Applications and disabled when users are logged on to the system. See the Oracle Applications Maintenance Utilities manual for more information about maintenance mode.

Please select an option:

1. Enable Maintenance Mode

2. Disable Maintenance Mode

3. Return to Main Menu

If you notice the message this menu selection also shows the maintenance status (disabled in our case) of the system.

You can also forcefully exit adadmin at any point of time by typing 'abort’, This will however result in a unclean exit of adadmin and the next time when you run adadmin you will be prompted with the option to start fresh or continue with the previous session as described earlier.

The arguments and options that you can use to refine the operation of a utility are listed, along with a brief description of how they work. Here’s an excerpt from the command line help for AD Administration.

* <localworkers> = Used in Distributed AD. The number of workers to run on the local machine.

* <flags> = Generic flags passed to AD utilities. The available values for Adadmin are hidepw and trace.

* <defaultsfile> = The defaults file name that is located under $APPL_TOP/admin/SID/ directory.

* <menu_option> = Skips the menu in Adadmin and executes the task

Usage:  adadmin [help=y]

adadmin [printdebug=y|n][localworkers=<localworkers>]

   [flags=hidepw|trace]

adadmin Non-Interactive mode

[defaultsfile=<$APPL_TOP/admin/SID/defaultsfile>]   [logfile=<logfile>][interactive=y|n]                                       [workers=<workers>][menu_option=<TASK_NAME>][restart=y|n]

The following table lists the menu options and the corresponding menu tasks:

Menu Option                                     Corresponding AD Administration Menu Choice

GEN_MESSAGES                            Generate message files

GEN_FORMS                                    Generate form files

GEN_REPORTS                                Generate reports files

GEN_JARS                                        Generate product JAR files

RELINK                                             Relink Applications programs

COPY_FILES                                    Copy files to destinations

CONVERT_CHARSET                    Convert character set

SCAN_APPLTOP                              Scan the APPL_TOP for exceptions

SCAN_CUSTOM_DIR                     Scan a CUSTOM directory for exceptions

LIST_SNAPSHOT                             List snapshots

UPDATE_CURRENT_VIEW          Update current view snapshot

CREATE_SNAPSHOT                     Create named snapshot

EXPORT_SNAPSHOT                     Export snapshot to file

IMPORT_SNAPSHOT                      Import snapshot from file

DELETE_SNAPSHOT                      Delete named snapshot

CHECK_FILES                                 Check for missing files

CMP_INVALID                                Compile APPS schema

CMP_MENU                                      Compile menu information

CMP_FLEXFIELDS                                     Compile flexfield data in AOL tables

RELOAD_JARS                                Reload JAR files to database

VALIDATE_APPS                            Validate APPS schema

CREATE_GRANTS                          Recreate grants and synonyms for APPS schema

Menu Option                                     Corresponding AD Administration Menu Choice

MAINTAIN_MLS                             Maintain multi-lingual tables

CHECK_DUAL                                 Check DUAL table

ENABLE_MAINT_MODE               Enable Maintenance Mode

DISABLE_MAINT_MODE                         Disable Maintenance Mode