Introduction To AD Utilities

Introduction to AD Utilities
Copyright © 2016, Oracle and/or its affiliates. All rights reserved.

Objectives
After completing this lesson, you should be able to:

• List the AD utilities and describe their functions
• Understand the usage of command line arguments and flags
• Describe parallel processing
• Identify the location and usage of log and restart files
17 - 2 Copyright © 2016, Oracle and/or its affiliates. All rights reserved.

AD Utilities: Overview
The AD (Applications DBA) utilities are used for maintenance

operations, and most are run from the command line.
The command line tools have similar:
• Interfaces
• Operation Oracle E-Business Suite
Oracle
• Input format Database Dual File System
• Report format
A few of the tools are
GUI-based
• These are accessed
through OAM AD Utilities

AD Utilities: Configuration and Environment Files
Most AD utilities require access to system parameters stored in

various configuration and environment files when processing
maintenance tasks.
The configuration and environment files are used by the AD
utilities to process maintenance tasks and have the following
characteristics:
• They are generated by AutoConfig during an installation or
upgrade
• You do not have to manually update or maintain the
information in these files
• They are updated when you run AutoConfig

AutoConfig Managed AD Utility Files
Name Location
EBSapps.env s_base
adconfig.txt APPL_TOP/admin
<context name>.env/cmd RDBMS ORACLE_HOME
APPS<context name>.env/cmd APPL_TOP
<context name>.env/cmd APPL_TOP
<context name>.env/cmd INST_TOP/appl/admin
adovars.env/cmd APPL_TOP/admin

Non-Auto Config AD Utility Files
Name Location
applora.txt APPL_TOP/admin
applorau.txt APPL_TOP/admin
applprod.txt APPL_TOP/admin
applterr.txt APPL_TOP/admin
fnddev.env FND_TOP

Command Line AD Utilities - 1
AD Utility Description
AD Administration Performs maintenance tasks on the Oracle E-

Business Suite file system and database.
AutoConfig Supports automated configuration of the Oracle E-

Business Suite instance
AD Check Digest Checks the integrity of Oracle E-Business Suite

patches downloaded from My Oracle Support.
AD Configuration Reports standard information about the installed

configuration of Oracle E-Business Suite
AD Controller Manages parallel workers in AD Administration
AD File Identification Reports the version and translation level of an

Oracle E-Business Suite file.
AD File Character Set Converts a file from one character set to another.
Converter

Command Line AD Utilities - 2
AD Utility Description
AD Merge Patch * Merges multiple patches into a single, integrated

patch.
AD Relink Relinks Oracle E-Business Suite executable

programs with the Oracle server product libraries.
AD Splicer Registers off-cycle products and custom

applications.
AD Job Timing Report Provides timing summary reports for jobs run by
parallel workers.
AD Online Patching Applies patches and other system updates.
Patch Application Generates customized installation instructions for a

Assistant patch.
Rapid Install Provides a wizard for entering parameters that are
specific to a new installation or an upgrade of an
Oracle E-Business Suite system.

Command Line AD Utilities: Where do you Run?
AD Utility Run From
AD Administration patch file system if online patching cycle is active.

Else execute from run file system
AutoConfig only run file system
AD Configuration run or patch file systems
AD Controller patch file system if online patching cycle is active.

AD File Identification run or patch file systems
AD File Character Set run or patch file systems

Converter

Command Line AD Utilities: Where do you Run?
AD Utility Run From
AD Merge Patch run or patch file systems
AD Relink run or patch file systems
AD Splicer patch file system if online patching cycle is active.

AD Job Timing Report run or patch file systems

AD Online Patching only run file system
Patch Application only run file system

Assistant

Web-Based AD Utilities - 1
Utility Description
Applied Patches Stores patch history information and allows you

to query patch and file history information.
AutoConfig Updates the Applications context with new

system configuration and helps manage the
system configuration files.
File Manager Enables the viewing of files that have been

updated by a patch.
License Manager Licenses products, country-specific

functionalities, or languages.
Patch Wizard Determines patches that have not been applied,

but should be applied to keep the system current.

Web-Based AD Utilities - 2
Utility Description
Register Flagged Files Used to record any files in which you have made
customizations.
Software Updates Provides an overview of all patching-related
information for your system.
Timing Reports Helps you monitor jobs that are running or view
statistics of completed AD Administration
maintenance sessions.

AD Utilities: Setting the Environment
Before you start any AD utility, you must first set the Oracle E-
Business Suite environment:
1. Log in as applmgr
2. Source the relevant file system using the EBSapps.env
script file
source/u01/R122_EBS/EBSapps.env run/patch
3. Ensure that there is sufficient temporary disk space

Running the Command Line AD Utilities
To run an AD utility from the command line:

1. Enter the utility’s program name
2. Answer the prompts
3. Exit by entering "abort" at any prompt
4. Restart by entering the utility’s program name again

Command Line Arguments: Overview
• AD utilities accept arguments on the start command line

that modify the actions performed by the utility
• Arguments may be either options or flags
• Some AD command line arguments may be required for
normal operation of an AD utility
• Command line arguments are in the <token>=<value>
format
• AD command line arguments are entered in lowercase

Command Line Arguments: Examples
Examples of valid command line arguments:

$ adadmin logfile=test.log
$ adadmin printdebug=y flags=hidepw
$ adadmin flags=nohidepw,trace
Examples of invalid command line arguments:
$ adadmin LOGFILE=TEST.log
$ adadmin flags=nohidepw, trace

Command Line Arguments: help
help
Used by All AD Utilities
Purpose Summarizes available command line options.
Values y or n
Default n
Example adadmin help=y

Command Line Arguments: logfile
logfile
Purpose Tells AD utilities what log file to use. Normally used in

non-interactive mode.
Values A file name (not a fully-qualified path name)
Default None, meaning that the utility will prompt for the log file name.
Example adctrl logfile=test.log

Command Line Arguments: interactive
interactive
Used by AD Administration, adop, and AD Controller
Purpose Tells AD utilities whether to run in interactive mode or non-

interactive mode.
Values y or n
Default y, meaning that the utility runs in interactive mode
Example adadmin interactive=n

defaultsfile=<$APPL_TOP/admin/SID/defaultsfile>

Command Line Arguments: defaultsfile
defaultsfile
Purpose Specifies the defaults file, which stores answers to interactive AD

utility questions. Normally used in non-interactive mode.
Values A fully-qualified filename. Must be under the

APPL_TOP/admin/<SID> directory.
Default None, meaning that no defaults file is used.

Example adctrl defaultsfile=/d1/apps/prodappl/admin/prod1/prod_def.txt

Command Line Arguments: workers
workers
Used by AD Administration and adop
Purpose Specifies the number of workers to run. Normally used in non-

interactive mode.
Values 1 to 999, inclusive
Default None, meaning that the program will prompt for the number of
workers to run.
Example adadmin workers=6

Command Line Arguments: localworkers
localworkers
Purpose Specifies the number of workers to run on the primary node in a

Distributed AD environment.
Values 1 to the maximum supported by your database, but not more than
999, Inclusive
Default Defaults to the value of the workers argument, which means all
workers run on the primary node.
Example adadmin workers=8 localworkers=3

Command Line Arguments: abandon
abandon
Used by adop
Purpose Abandons the previous failed apply command and starts a new
apply command
Values yes or no
Default no
Example adop phase=apply patches=<> abandon=yes restart=no

Command Line Arguments: restart
restart
Purpose Tells AD utilities to restart an existing session in non-interactive

mode. Only valid when interactive=n is also specified.
Values yes or no
Default n, meaning that the utility run in non-interactive mode will expect
to run a completely new session.
Example adop phase=apply patches=<> abandon=yes restart=no

Command Line Arguments: menu_option
menu_option
Used by AD Administration and AD Controller
Purpose When running one of these utilities non-interactively, used to

connect the actions in a defaults file with a specific menu item.
Values Varies. See utility specific section for details
Default n/a
Example adctrl interactive=n

defaultsfile=$APPL_TOP/admin/prod/defs.txt
menu_option=SHOW_STATUS

Command Line Arguments: printdebug
printdebug
Purpose Tells AD programs to display extra debugging information. In

some cases, the amount of extra debugging information is
substantial.
Values y or n
Default n
Example adadmin printdebug=y

Command Line Arguments: wait_on_failed_job
wait_on_failed_job
Purpose Directs the utilities to wait for user input in a non-interactive

session when a job fails.
Values y or n
Default n
Example adadmin wait_on_failed_job=yes

Command Line Arguments:
parallel_index_threshold
parallel_index_threshold
Purpose Specifies the number of blocks in a table.
Values 0 to 2147483647; if set to 0, indexes are created with parallel

workers and serial DML
Default 20000; meaning a threshold of 20,000 blocks.
Example adadmin parallel_index_threshold=15000

Command Line Arguments: flags
flags
Purpose Generic flags passed to AD utilities. Information about specific

flags are covered on the following pages.
Values Information about specific flags are covered on the following

pages.
Default None, meaning that no flags have been passed.
Example adadmin flags=hidepw

AD Utilities Flags: trace
flags=trace
Purpose Tells the AD utility whether to log all database operations to a

trace file.
Default notrace
Comments Database trace files created while running an AD utility may aid
debugging.
Example adadmin flags=trace

AD Utilities Flags: logging
flags=logging
Purpose Tells the AD utility whether to create indexes using the logging or
nologging mode.
Default logging
Comments Use of nologging may increase performance when creating

indexes. However, it also makes database media recovery
incomplete, and does not work with standby databases.
Example adop flags=logging

AD Utilities Flags: hidepw
flags=hidepw
Purpose Directs the utilities to either hide or show passwords in AD Utility

log files.
Default hidepw
Comments By default, lines in an AD utility log file containing passwords are

modified to hide the passwords
Example adadmin flags=nohidepw

AD Utilities: Common Features
• AD Feature Versions
• AD Prompts
• Interactive and Non-interactive Processing
• Parallel Processing
• Log and Restart Files
• Manager and Worker Log Messages

Version Matching
• AD requires that the files on the file system and the tables
in the database match
• Each major feature has both a file system and database
version
• AD only enables the feature if the file system and database
versions match

AD Utilities: Prompts
Prompts for AD Utilities typically:

• Ask for information needed to complete a task
• Include a description of the information needed
• May include a default answer

Interactive and Non-interactive Processing
Interactive Processing:
• Most of the maintenance tasks are interactive
• Require user intervention, primarily in the form of
responding to prompts
Non-interactive Processing:
• Requires little or no user intervention
• Requires a defaults file that contains the information
necessary to complete the task without user intervention

Parallel Processing: Introduction
• AD Administration and adop can perform some tasks using

parallel processing
• Parallel processing provides better throughput, better use
of available resources, and overall reduction in the time it
takes to complete tasks
• Parallel processing is typically used to:
– Compile invalid objects
– Run database driver tasks, such as SQL scripts
– Generate various types of files, such as forms, reports, and
messages

Parallel Processing: Managers
The manager:
• Updates the FND_INSTALL_PROCESSES table with a
subset of the list of jobs, one job per worker
• The manager starts the workers and uses the
CONTROL_CODE and STATUS columns to assign tasks
• Polls the CONTROL_CODE and STATUS columns,
looking for updates from the workers
• Updates each row with the next task in the list, and leaves
messages for the worker
• Tells the workers to shut down
• Drops the FND_INSTALL_PROCESSES table

Parallel Processing: Workers
Each worker:
• Updates the STATUS column of the
FND_INSTALL_PROCESSES table, giving the manager a
report on its progress
• Starts processing when instructed by the manager
• Reports a failed status, if there is a failure
• May spawn other child processes that do the actual work

Parallel Processing: Deferred Jobs
• The first time a job fails, the manager automatically defers

it to the end of the current phase and assigns a new job to
the worker
• If the deferred job fails the second time it is run and the
total runtime of the job is less than approximately ten
minutes, the manager defers it again
• If the deferred job fails a third time (or if the job’s total
runtime is not less than about ten minutes the second time
it is run) the job stays at failed status and the worker waits
– At this point, you must address the cause of the failure, and
then restart the job using AD Controller

Database Processing Phases - 1
• Database maintenance tasks take a phased approach

• All phases use parallel processing
• Each phase must complete successfully before the next
one begins
• Phases are ordered to minimize object dependency issues
(for example, all package specifications are created before
any package bodies)
– This maximizes concurrency of the worker processes

Database Processing Phases - 2
While the utility runs, the manager will display text showing the
current status of workers and jobs and the current phase:
There are now 16217 jobs remaining (current phase=con):

4 running, 42 ready to run, and 16171 waiting.
Completed: file hrobsakw.sql on worker 2 for product per username
HR.
Time is: Tue Jan 05 2010 18:24:30
Assigned: file pjmcon1.drv on worker 2 on product pjm username
PJM.
Time is: Tue Jan 05 2010 18:24:30
This example shows that the AD utility has 16,217 jobs

remaining, and that it is in the con phase (disable
constraints and foreign keys)

Distributed AD
• Jobs are assigned to multiple workers on different nodes,

improving scalability and performance
• Useful where low cost systems are deployed as multiple,
smaller application tier machines
• Workers for the same AD session can be started on
multiple nodes
AD AD
AD
AD
Node
array

Distributed AD: Requirements
• The AD workers create and update file system objects as

well as database objects
• A shared APPL_TOP must therefore be used to ensure the
files are created in a single, centralized location
AD AD
AD AD
AD AD

Distributed AD: Usage
Key points to using Distributed AD are as follows:

• You can start an AD Administration session on any shared
APPL_TOP node, specifying:
– The number of local workers
– The total number of workers
(local + remote)
• You can start an AD Controller session from any shared
APPL_TOP node
– Both local and non-local workers can be specified

Log Files
AD Administration records your AD Administration

session in a text file you specify. Enter your
AD Administration log file name or press
[Return] to accept the default name shown in
brackets.
Filename [adadmin.log] :

Worker Log Files
Worker log files are:

• Called adwork<number>.log
• Written to the s_ne_base/EBSapps/log/adadmin directory

Restart Files
Restart files:
• Are used by an AD utility to continue processing at the
point where it stopped
• Reside in the APPL_TOP/admin/<SID>/restart directory
• Contain information about what processing has already
been completed, so that the utility can pick up where it left
off

Manager and Worker Log Messages - 1
When AD utilities are running, messages of various types are

displayed on the screen
• For example:
Assigned: file ad_wait1sec.sql on worker 1 for product

ad username APPLSYS.
FAILED: file ad_wait1sec.sql on worker 1 for product
ad username APPLSYS.
ATTENTION: All workers either have failed or are

waiting:

Manager and Worker Log Messages - 2
The manager displays a message if a worker cannot complete

its job
• For example:
FAILED: file adcjmdt.sql on worker 1 for product ad
username APPLSYS.

Summary
In this lesson, you should have learned how to:

• List the AD utilities and describe their functions
• Understand the usage of command line arguments and
flags
• Describe parallel processing
• Identify the location and usage of log and restart files

Introduction To AD Utilities

Încărcat de

Informații document

Titlu original

Drepturi de autor

Formate disponibile

Partajați acest document

Partajați sau inserați document

Opțiuni de partajare

Vi se pare util acest document?

Este necorespunzător acest conținut?

Drepturi de autor:

Formate disponibile

Introduction To AD Utilities

Încărcat de

Drepturi de autor:

Formate disponibile

Introduction to AD Utilities

Copyright © 2016, Oracle and/or its affiliates. All rights reserved.

After completing this lesson, you should be able to:

17 - 2 Copyright © 2016, Oracle and/or its affiliates. All rights reserved.

The AD (Applications DBA) utilities are used for maintenance

17 - 3 Copyright © 2016, Oracle and/or its affiliates. All rights reserved.

Most AD utilities require access to system parameters stored in

17 - 4 Copyright © 2016, Oracle and/or its affiliates. All rights reserved.

<context name>.env/cmd RDBMS ORACLE_HOME

APPS<context name>.env/cmd APPL_TOP

<context name>.env/cmd APPL_TOP

<context name>.env/cmd INST_TOP/appl/admin

17 - 5 Copyright © 2016, Oracle and/or its affiliates. All rights reserved.

17 - 6 Copyright © 2016, Oracle and/or its affiliates. All rights reserved.

AD Administration Performs maintenance tasks on the Oracle E-

AutoConfig Supports automated configuration of the Oracle E-

AD Check Digest Checks the integrity of Oracle E-Business Suite

AD Configuration Reports standard information about the installed

AD Controller Manages parallel workers in AD Administration

AD File Identification Reports the version and translation level of an

17 - 7 Copyright © 2016, Oracle and/or its affiliates. All rights reserved.

AD Merge Patch * Merges multiple patches into a single, integrated

AD Relink Relinks Oracle E-Business Suite executable

AD Splicer Registers off-cycle products and custom

Patch Application Generates customized installation instructions for a

17 - 8 Copyright © 2016, Oracle and/or its affiliates. All rights reserved.

AD Utility Run From

AD Administration patch file system if online patching cycle is active.

AD Configuration run or patch file systems

AD Controller patch file system if online patching cycle is active.

AD File Identification run or patch file systems

AD File Character Set run or patch file systems

17 - 9 Copyright © 2016, Oracle and/or its affiliates. All rights reserved.

AD Utility Run From

AD Merge Patch run or patch file systems

AD Relink run or patch file systems

AD Splicer patch file system if online patching cycle is active.

AD Job Timing Report run or patch file systems

Patch Application only run file system

17 - 10 Copyright © 2016, Oracle and/or its affiliates. All rights reserved.

Applied Patches Stores patch history information and allows you

AutoConfig Updates the Applications context with new

File Manager Enables the viewing of files that have been

License Manager Licenses products, country-specific

Patch Wizard Determines patches that have not been applied,

17 - 11 Copyright © 2016, Oracle and/or its affiliates. All rights reserved.

17 - 12 Copyright © 2016, Oracle and/or its affiliates. All rights reserved.

17 - 13 Copyright © 2016, Oracle and/or its affiliates. All rights reserved.

To run an AD utility from the command line:

17 - 14 Copyright © 2016, Oracle and/or its affiliates. All rights reserved.

• AD utilities accept arguments on the start command line

17 - 15 Copyright © 2016, Oracle and/or its affiliates. All rights reserved.

Examples of valid command line arguments:

Examples of invalid command line arguments:

17 - 16 Copyright © 2016, Oracle and/or its affiliates. All rights reserved.

Used by All AD Utilities

Purpose Summarizes available command line options.

17 - 17 Copyright © 2016, Oracle and/or its affiliates. All rights reserved.

Used by All AD Utilities

Purpose Tells AD utilities what log file to use. Normally used in

Values A file name (not a fully-qualified path name)

Example adctrl logfile=test.log

17 - 18 Copyright © 2016, Oracle and/or its affiliates. All rights reserved.