AD Command Line Options

This document contains information about AD command line options. You should 
read and understand all content described here before you begin using these 
options. The most current version of these notes is document 233038.1 on 
OracleMetaLink. There is a change log at the end of this document. 
This document contains the following sections: 

•  Section 1: Overview  
Introduction of AD command line options and how they are used.

•  Section 2: Command Line Options For All Major AD Utilities  
Details of valid command line options for all major AD utilities. 

•  Section 3:  Command Line Options For AutoPatch
    
Details of valid command line options for AutoPatch. 

•  Section 4:  Command Line Options For One or More AD Utilities
    
Details of valid command line options for one or more AD utilities. 

•  Section 5: Available Documentation  
Additional documentation for AD utilities.

Section 1: Overview

In addition to their standard functionality, AD utilities can accept command line 
options to modify the actions performed by the utility. This document describes 
the AD command line options. Some AD command line options are not 
documented here because they are either obsolete or not normally specified by 
end users. 
For simplicity, AD utilities are referred to in these examples by their executable 
names instead of their utility names. For details about the AD utilities, see Oracle 
Applications Maintenance Utilities. Here is a mapping of executable names to 
utility names: 
Executable Name Utility Name
adpatch AutoPatch
adadmin AD Administration
 adaimgr AutoUpgrade
adctrl AD Controller
All AD command line options have the format: token=value. In general, you 
should enter AD command line options in lowercase. The token is converted to 
lower­case internally, but the value is not. In some cases, value is a comma­
separated list of options. AD command line options cannot contain embedded 
whitespace characters. 
Examples of valid command­line argument syntax are: 
adpatch options=nocopyportion,nogenerateportion
adpatch printdebug=y
Examples of invalid command­line argument syntax are: 
adpatch options=nocopyportion, nogenerateportion (contains imbeded
whitespace)
adpatch OPTIONS=NOCOPYPORTION,NOGENERATEPORTION (keyword will
be recognized, but values won't)
Example of using multiple command­line options: 
adpatch printdebug=y options=validate flags=hidepw

Section 2: Command Line Options For All Major AD Utilities

help=y|n
Purpose: Summarizes available command line options.
Valid values: y or n
Default value: n
Example adpatch help=y
 
logfile=log-file-name 
Tells AD utilities what log file to use. Normally
Purpose:
used in non-interactive mode.
Valid values: A file name (not a fully-qualified path name)
none, meaning that the utility will prompt for the
Default value:
log file name
Example adpatch logfile=test.log
 
printdebug=y|n
Tells AD programs to display extra debugging
Purpose: information. In some cases, the amount of extra
debugging information is substantial.
Valid values: y or n
Default value: n
Example adpatch printdebug=y
 
flags=list-of-flags 
 Generic flags passed to AD utilities. See table
Purpose:
below for more information.
Valid values: A comma-separated list of flags
Default value: none, meaning that no flags have been passed
Example adpatch flags=hidepw
Table of flags:
Flag Purpose Default Comments
hidepw Tells password nohidepw Starting in AD Mini-pack H, lines in an
hider feature AD utility log file containing
whether to omit passwords can be automatically
the 'HIDEPW:' masked to not display the passwords.
comments in AD
utility log files • When nohidepw is specified, each line
containing masked passwords is
followed by a corresponding line
prefixed with 'HIDEPW:' which
contains the original line with
passwords included.
• When hidepw is specified, the
additional 'HIDEPW:' line is not
displayed.

The intent of this feature is to include

passwords protected by 'HIDEPW:'
comments in the AD program log file
by default so that debugging is easier
and stripping the passwords (using
grep -v 'HIDEPW:' file > file_no_pws on
UNIX, for example) is easy. For cases
where security is more important than
ease of debugging, hidepw can be
specified to prevent any passwords
from being listed in the AD utility log
file.
logging Tells the AD utility logging in Use of NOLOGGING when creating indexes
whether to create adpatch may increase performance. However it also
indexes using nologging makes database media recovery incomplete and
LOGGING or in does not work with standby databases.
NOLOGGING adaimgr
mode • LOGGING is the default in adpatch so
that database media recovery and
standby databases work by default. Use
of flags=nologging in adpatch is
discouraged for production systems
unless a complete backup is taken both
 before and after running adpatch.

• NOLOGGING is the default in adaimgr

because running adaimgr with an
enabled standby database or in archive
log mode doesn't make any sense. If you
take a complete database backup before
and after running adaimgr, it is safe to
take advantage of the extra performance
gain provided by NOLOGGING.

flags=nologging affects indexes created

through ODF only, not indexes
created through SQL scripts.
trace Tells the AD utility notrace Sometimes it is valuable to get RDBMS trace
whether to log all files during an AD utility run for debugging
database purposes. The flags=trace option provides an
operations to a easy way to do this.
trace file Note that flags=trace only traces
database operations internal to the
AD utility itself. Database operations
in SQL scripts or external programs
run by the AD utility are not recorded
by flags=trace.
This option creates multiple trace files
for the AD utility and the AD workers.
There is a new trace file for each time
the utility reconnects to the database.

Section 3: Command Line Options For AutoPatch

apply=y|n 
Purpose: Tells adpatch whether to run in test mode.
Valid values: y or n
Default value: y, meaning that adpatch does not run in test mode
Example adpatch apply=n
 
driver=patch-driver-file-name 
Tells adpatch the name of the patch driver file. Normally used in
non-interactive mode. Only valid when patchtop=patch-top-level-
Purpose: directory is also specified. It is valid to specify a comma-separated
list of patch driver file names. This is not recommended and may be
desupported in a future Oracle Applications release.
Valid values: A file name
 Default value: none, meaning that adpatch prompts for the patch driver file name
adpatch patchtop=/d1/apps/patches/2344175
Example driver=c2344175.drv
 
order=forward|backward 
Tells adpatch how to organize its list of jobs to run
Purpose: in a phase. Does not affect the order in which
phases (or sub-phases) are run.
Valid values: forward or backward
forward, meaning that adpatch organizes its list of
Default value: jobs to run in a phase in the order they are listed in
the patch driver file
Example adpatch order=backward
 
patchtop=patch-top-level-directory 
Tells adpatch the top-level directory for the current
Purpose:
patch. Normally used in non-interactive mode.
Valid values: A fully-qualified directory name
none, meaning that adpatch prompts for the patch
Default value:
directory
Example adpatch patchtop=/d1/apps/patches/2344175
 
preinstall=y|n 
Tells adpatch whether to run in pre-install mode.
Pre-install mode is used to update AD utilities
Purpose:
before an upgrade and to apply family consolidated
upgrade patches.
Valid values: y or n
n, meaning that adpatch does not run in pre-install
Default value:
mode
Example adpatch preinstall=y
 
options=list-of-options 
Generic options passed to adpatch. See tables
Purpose:
below for more information.
Valid values: A comma-separated list of options
Default value: none, meaning that no options have been passed
Example adpatch options=integrity
Table of adpatch generic options:
Option Purpose Default Usage (options=) Comments
autoconfig Tells autoconfig Use The more
AutoPatch options=noautoconfig common method
to run if you are applying a is to merge the
AutoConfig number of patches in patches first with
 automaticall sequence and want to AD Merge Patch.
y. run AutoConfig once,
after applying the last
patch of the sequence.
check_exclusive If the nocheck_exclusive Use check_exclusive check_exclusive
Concurrent to check for other is handy to avoid
Sessions running adpatch unintended
feature is sessions. attempts to run
enabled, multiple patches
tells at the same time
adpatch on the same
whether to APPL_TOP
print a when the
warning Concurrent
message Sessions feature
when is enabled.
another
adpatch
session is
currently
running
against this
APPL_TOP.
checkfile Tells checkfile Use nocheckfile to checkfile
adpatch to turn off the checkfile provides
either skip feature. significant
running performance
exec, SQL, benefits for most
and exectier cases. There are
commands very few cases in
if they are which you would
recorded as want to run with
already run nocheckfile.
or record
them as
having run
after
running
them.
compiledb Tells adpatch compiledb for Use compiledb or In cases where
to standard patches nocompiledb to multiple non-
automatically change the default merged patches
compile nocompiledb for action. are applied in a
invalid objects standard patch maintenance
in the database translations, window, you can
after running use nocompiledb
 actions to save time.
normally found documentation
in the database patches, and Merging
driver. documentation multiple
patch patches and
translations applying a
single
merged patch
is normally a
better
strategy.
compilejsp Tells adpatch compilejsp for Use compilejsp or In cases where
whether to standard patches nocompilejsp to multiple non-
automatically change the default merged patches
compile out- nocompilejsp for action. are applied in a
of-date JSP standard patch maintenance
files. JSP files translations, window, you can
are only documentation use nocompilejsp
compiled if the patches, and to save time.
patch contains documentation
copy actions patch Merging
for at least one translations multiple
JSP file. patches and
applying a
single
merged patch
is normally a
better
strategy.
copyportion Tells copyportion Use nocopyportion to Mostly useful
adpatch tell adpatch not to with unified
whether to perform copy driver drivers
run actions.
commands
normally
found in a
copy driver.
databaseportion Tells databaseportion Use Mostly useful
adpatch nodatabaseportion to with unified
whether to tell adpatch not to drivers
run perform database
commands driver actions.
normally
found in a
database
 driver.
generateportion Tells generateportion Use Mostly useful
adpatch nogenerateportion to with unified
whether to tell adpatch not to drivers
run perform generate
commands driver actions.
normally
found in a
generate
driver.
hotpatch Tells nohotpatch Use hotpatch to tell AutoPatch aborts
AutoPatch adpatch to apply a the patching
to apply a patch while session if
patch maintenance mode is maintenance
regardless disabled on the mode is disabled
of whether system. and the
the Oracle options=hotpatch
Applications command is not
system is in used.
maintenanc
e mode.
integrity Tells nointegrity Use ingegrity to As the integrity
adpatch perform patch of Oracle
whether to integrity checking. Applications
perform patches is
patch checked before
integrity they are released,
checking, the default of
which nointegrity is
verifies that safe and avoids
the version some adpatch
of each file overhead.
referenced
in a copy
action
matches
the version
present in
the patch.
maintainmrc Tells maintainmrc for Use maintainmrc or In cases where
adpatch standard patches nomaintainmrc to multiple non-
whether to change the default merged patches
automaticall nomaintainmrc action. are applied in a
y maintain for standard maintenance
the MRC patch window, you can
 schema use
after translations, nomaintainmrc
running documentation to save time.
actions patches, and
normally documentation Merging
found in the patch multiple
database translations patches and
driver. The applying a
MRC single
schema is merged patch
only is normally a
maintained better
if the MRC strategy.
feature is
enabled.
parallel Tells parallel Use noparallel to tell Oracle
adpatch adpatch to run actions Applications
whether to serially. patches are tested
run actions using parallel
that update mode. Use of
the noparallel is
database in discouraged. It
parallel (like may be
sql) and desupported in a
actions that later Oracle
generate Applications
files in release.
parallel (like
genform) .
prereq Tells prereq Use noprereq to turn prereq prevents
adpatch off prerequisite patch you from
whether to checking. applying a patch
perform without first
prerequisite applying all
patch required
checking prerequisite
prior to patches. noprere
running q should not
patch driver normally be used.
files that
contain
actions
normally
found in the
copy driver.
revcache Tells revcache Use norevcache to With AD Mini-
adpatch tell adpatch not to pack G, adpatch
whether to load the package only loads the
load the revision cache. package revision
package cache when
revision package
cache (if commands
adpatch without checkfile
determines syntax are
it is present in the
needed). patch driver file,
there is not much
reason to use
norevcache.
Specifying
norevcache will
cause all package
commands
without checkfile
syntax to run.
validate Tells novalidate Use validate to tell Useful for
adpatch adpatch to connect to finding problems
whether to all registered Oracle with incorrectly-
connect to Applications registered Oracle
all schemas. Applications
registered schemas or
Oracle schemas with
Applications invalid
schemas at passwords.
the start of
the patch.
  
Table of adpatch options that control specific actions in a patch driver file: 
  
Usage
Option Purpose Default Comments
(options=)
copy The copy command copy Use nocopy to
compares file turn off these
versions in a patch commands.
with files in the
Applications file
system and copies
files that have
higher versions in
the patch to the
 Applications file
system.
exec The exec command exec Use noexec to
runs executable turn off these
programs. commands.
exectier The exectier exectier Use noexectier The nocopyportion,
command runs to turn off these nodatabaseportion,
executable commands. and
programs on a nogenerateportion
specific list of tiers. options ignore exectier
actions. In some
unusual cases, you may
need to specify
noexectier along with
no*portion in order to
disable exectier
actions that perform
copy-, database-, or
generate-related logic.
forcecopy The forcecopy forcecop Use noforcecopy
command copies y to change the
the files in a patch default.
to the Applications
file system without
comparing the
version number of
the patch files with
existing files.
genform The genform genform Use nogenform
command to turn off these
generates form commands.
files.
genfpll The genfpll genfpll Use nogenfpll to
command turn off these
generates forms commands.
PL/SQL library files.
gengpll The gengpll gengpll Use nogengpll to
command turn off these
generates Oracle commands.
Graphics PL/SQL
library files.
genmenu The genmenu genmenu Use nogenmenu
command to turn off these
generates forms commands.
menu files.
genmesg The copy command genmesg Use nogenmesg
generates Oracle to turn off these
Applications commands.
message files.
genogd The genogd genogd Use nogenogd
command to turn off these
generates Oracle commands.
Graphics files.
genrep The genrep genrep Use nogenrep to
command turn off these
generates reports commands.
files.
genrpll The genrpll genrpll Use nogenrpll to
command turn off these
generates reports commands.
PL/SQL library files.
genwfmsg The genwfmsg genwfmsg Use
command nogenwfmsg to
generates turn off these
Workflow resource commands.
files.

jcopy The jcopy command jcopy Use nojcopy to

updates Java class turn off these
files. commands.
libin The libin command libin Use nolibin to
copies files into turn off these
the product library. commands.
libout The libout libout Use nolibout to You must also specify
command extracts turn off these nolibin and nocopy if
files from the commands. you specify nolibout.
product library.
link The link command link Use nolink to
relinks executables turn off these
with the Oracle commands.
server.
makedir The makedir makedir Use nomakedir
command creates to turn off these
an empty directory. commands.
sql The sql command sql Use nosql to turn
runs SQL scripts. off these
commands.
Section 4: Command Line Options For One or More AD Utilities

abandon=y 
Used by: adpatch, adadmin
Tells AD utilities to abandon an existing non-interactive
Purpose:
session. Can be used only when interactive=n is also specified..
Valid values: y or n.
n, meaning that the last utility run non-interactively did not
Default value:
successfully complete the processing..
Example adpatch interactive=n abandon=y
 
defaultsfile=defaults-file-name 
Used by: adpatch, adadmin, adctrl
Specifies the defaults file which stores answers to interactive
Purpose:
AD utility questions. Normally used in non-interactive mode.
A fully-qualified filename. Must be under the
Valid values:
$APPL_TOP/admin/<SID> directory.
Default value: none, meaning that no defaults file is used.
adpatch
Example defaultsfile=/d1/apps/prodappl/admin/prod1/prod_def.txt
 
distributed=y 
Used by: adctrl
Specifies use of adctrl for Distributed AD. If
specified by itself, causes adctrl to wait in a loop to
Purpose:
spawn a specified range of workers on the current
machine.
Valid values: y
none, meaning that adctrl does not operate in
Default value: Distributed AD mode. Instead, it brings up its
standard menu.
Example adctrl distributed=y
 
force_restart=y 
Used by: adctrl
Tells adctrl to restart specific workers for
Purpose: Distributed AD.
Only valid when distributed=y is also specified.
Valid values: y
none, meaning that adctrl either brings up its
Default value: standard main menu or waits in a loop to spawn a
specified range of workers on the current machine.
Example adctrl distributed=y force_restart=y
 
interactive=y|n 
Used by: adpatch, adadmin
Tells AD utilities whether to run in interactive
Purpose:
mode or non-interactive mode.
Valid values: y or n
Default value: y, meaning that the utility runs in interactive mode
Example adpatch interactive=n
 
localworkers=number-of-local-workers 
Used by: adpatch, adadmin
Used in Distributed AD to specify the number of
Purpose:
workers to run on the current machine.
Valid values: zero to total number of workers (max=999)
none, meaning that all workers will run on the
Default value:
current machine
Example adpatch workers=10 localworkers=5
 
menu_option=menu-option-value 
Used by: adadmin, adctrl
When running one of these utilities non-
Purpose: interactively, used to connect the actions in a
defaults file with a specific menu item.
See list of menu options in the description of these
utilities in Oracle Applications Maintenance
Valid values:
Utilities. Must be used with interactive=n and
defaultsfile=<name of defaults file>.
Default value: N/A
adctrl interactive=n
Example defaultsfile=$APPL_TOP/admin/prod/ctrldefs.txt
menu_option=SHOW_STATUS
 
parallel_index_threshold=parallel-index-threshold-value 
Used by: adadmin, adpatch
Specifies the number blocks in a table. If a table
contains less blocks than the threshold setting,
indexes are created with parallel workers and serial
Purpose:
DML. If the table contains more blocks than the
threshold setting, indexes are created with one
worker and parallel DML.
0 to 2147483647; if set to 0, indexes are created
Valid values:
with parallel workers and serial DML.
Default value: 20000; meaning a threshold of 20,000 blocks.
Example adpatch parallel_index_threshold=15000
 
restart=y|n 
Used by: adpatch, adadmin
Tells AD utilities to restart an existing session in
Purpose: non-interactive mode. Only valid when
interactive=n is also specified.
Valid values: y or n
n, meaning that the utility run in non-interactive
Default value:
mode will expect to run a completely new session.
Example adpatch interactive=n restart=y
 
wait_on_failed_job=y|n 
Used by: adpatch, adadmin
Directs the utilities to wait for user input in a non-
Purpose: interactive
session when a job fails.
Valid values: y or n
Default value: n
Example adpatch wait_on_failed_job=yes
 
workers=number-of-workers 
Used by: adpatch, adadmin
Specifies the number of workers to run. Normally
Purpose:
used in non-interactive mode.
Valid values: 1 to 99, inclusive
none, meaning that the program will prompt for the
Default value:
number of workers to run
Example adpatch workers=6