3/29/13 Document Display

AD Command Line Options for Release R12 [ID 1078973.1]

Modified: Jul 30, 2012 Type: REFERENCE Status: PUBLISHED Priority: 3

AD Command Line Options

April 2010

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 1078973.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
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
tokenis converted to lower-case internally, but the valueis not.In some cases, valueis 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

https://support.oracle.com/epmos/faces/ui/km/SearchDocDisplay.jspx?_adf.ctrl-state=18z88yi99f_69 1/8
3/29/13 Document Display

Section 2: Command Line Options For All Major AD Utilities

help=y|n

Purpose: Summarizes available command line options.

Valid values: yor n
Default value: n
Example adpatch help=y

logfile=log-file-name

Purpose: Tells AD utilities what log file to use.Normally used in non-interactive mode.
Valid values: A file name (not a fully-qualified path name)
Default value: none, meaning that the utility will prompt for the log file name
Example adpatch logfile=test.log

printdebug=y|n

Tells AD programs to display extra debugging information. In some cases, the

Purpose:
amount of extra debugging information is substantial.
Valid values: yor n
Default value: n
Example adpatch printdebug=y

flags=list-of-flags

Purpose: Generic flags passed to AD utilities. See table 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 hider feature nohidepw
whether to omit the Starting in AD Mini-pack H, lines in an AD utility log file containing
'HIDEPW:' comments in AD passwords can be automatically masked to not display the passwords.
utility log files
When nohidepwis specified, each line containing masked
passwords is followed by a corresponding line prefixed with
'HIDEPW:' which contains the original line with passwords
included.
When hidepwis 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_pwson UNIX, for example) is easy.For cases where security is
more important than ease of debugging, hidepwcan be specified to
prevent any passwords from being listed in the AD utility log file.

logging Tells the AD utility whether
to create indexes using
LOGGING or NOLOGGING
mode
loggingin Use of NOLOGGING when creating indexes may increase
adpatch performance.However it also makes database media recovery
incomplete and does not work with standby databases.
LOGGING is the default in adpatch so that database media
recovery and standby databases work by default. Use of
flags=nologgingin adpatch is discouraged for production
systems unless a complete backup is taken both before and after
running adpatch.

flags=nologgingaffects indexes created through ODF only, not indexes

https://support.oracle.com/epmos/faces/ui/km/SearchDocDisplay.jspx?_adf.ctrl-state=18z88yi99f_69 2/8
3/29/13 Document Display
flags=nologgingaffects indexes created through ODF only, not indexes
created through SQL scripts.

trace Tells the AD utility whether notrace Sometimes it is valuable to get RDBMS trace files during an AD utility run
to log all database for debugging purposes.The flags=traceoption provides an easy way
operations to a trace file to do this.

Note that flags=traceonly 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: yor 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-directoryis also specified.It is valid to specify a comma-separated list
Purpose:
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
Example adpatch patchtop=/d1/apps/patches/2344175 driver=c2344175.drv

order=forward|backward

Purpose: Tells adpatch how to organize its list of jobs to run in a phase.Does not affect
the order in which phases (or sub-phases) are run.
Valid values: forwardor backward
forward, meaning that adpatch organizes its list of jobs to run in a phase in
Default value:
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 patch.Normally used in
Purpose:
non-interactive mode.
Valid values: A fully-qualified directory name
Default value: none, meaning that adpatch prompts for the patch 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

Purpose: update AD utilities before an upgrade and to apply family consolidated
upgrade patches.
Valid values: yor n
Default value: n, meaning that adpatch does not run in pre-install mode
Example adpatch preinstall=y

options=list-of-options
https://support.oracle.com/epmos/faces/ui/km/SearchDocDisplay.jspx?_adf.ctrl-state=18z88yi99f_69 3/8
3/29/13
Purpose: Generic options passed to adpatch.See tables 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
autoconfig
Tells AutoPatch to run
AutoConfig automatically.
checkfile
Tells adpatch to either skip
running exec, SQL, and
exectiercommands if
they are recorded as
already run or record them
as having run after running
them.
compiledb Tells adpatch to
automatically compile
invalid objects in the
database after running
actions normally found in
the database driver.
compilejsp Tells adpatch whether to
automatically compile out-
of-date JSP files. JSP files
are only compiled if the
patch contains copyactions
for at least one JSP file.
copyportion
Tells adpatch whether to
run commands normally
found in a copy driver.
databaseportion
Tells adpatch whether to
run commands normally
found in a database driver.
generateportion
Tells adpatch whether to
run commands normally
found in a generate driver.
hotpatch
Tells AutoPatch to apply a
patch regardless of
whether the Oracle
https://support.oracle.com/epmos/faces/ui/km/SearchDocDisplay.jspx?_adf.ctrl-state=18z88yi99f_69
Document Display
Default Usage (options=) Comments
autoconfig Use options=noautoconfig if you The more common method
are applying a number of is to merge the patches
patches in sequence and want to first with AD Merge Patch.
run AutoConfig once, after
applying the last patch of the
sequence.
checkfile Use nocheckfileto turn off the checkfileprovides
checkfile feature. significant performance
benefits for most cases.
There are very few cases
in which you would want to
run with nocheckfile.
compiledbfor Use compiledb or In cases where multiple
standard patches nocompiledb to change the non-merged patches are
default action. applied in a maintenance
nocompiledbfor window, you can use
standard patch nocompiledbto save time.
translations, Merging multiple patches
documentation and applying a single
patches, and merged patch is normally a
documentation patch better strategy.
translations
compilejspfor Use compilejsp or In cases where multiple
standard patches nocompilejspto change the non-merged patches are
default action. applied in a maintenance
nocompilejspfor window, you can use
standard patch nocompilejspto save
translations, time.
documentation
patches, and Merging multiple patches
documentation patch and applying a single
translations merged patch is normally a
better strategy.
copyportion Use nocopyportionto tell Mostly useful with unified
adpatch not to perform copy drivers
driver actions.
databaseportion Use nodatabaseportionto tell Mostly useful with unified
adpatch not to perform database drivers
driver actions.
generateportion Use nogenerateportionto tell Mostly useful with unified
adpatch not to perform generate drivers
driver actions.
nohotpatch Use hotpatchto tell adpatch to AutoPatch aborts the
apply a patch while maintenance patching session if
mode is disabled on the system. maintenance mode is
disabled and the
4/8
3/29/13
whether the Oracle
Applications system is in
maintenance mode.
integrity
Tells adpatch whether to
perform patch integrity
checking, which verifies
that the version of each file
referenced in a copyaction
matches the version
present in the patch.
parallel
Tells adpatch whether to
run actions that update the
database in parallel (like
sql) and actions that
generate files in parallel
(like genform) .
revcache
Tells adpatch whether to
load the package revision
cache (if adpatch
determines it is needed).
validate
Tells adpatch whether to
connect to all registered
Oracle Applications
schemas at the start of the
patch.
Table of adpatch options that control specific actions in a patch driver file:
Option Purpose
copy
The copycommand compares file
versions in a patch with files in the
Applications file system and copies
files that have higher versions in the
patch to the Applications file system.
exec
The execcommand runs executable
programs.
exectier
The exectiercommand runs
executable programs on a specific list
of tiers.
forcecopy
The forcecopycommand copies the forcecopy
files in a patch to the Applications file
https://support.oracle.com/epmos/faces/ui/km/SearchDocDisplay.jspx?_adf.ctrl-state=18z88yi99f_69
Document Display
disabled and the
options=hotpatch
command is not used.
nointegrity Use ingegrityto perform patch As the integrity of Oracle
integrity checking. Applications patches is
checked before they are
released, the default of
nointegrityis safe and
avoids some adpatch
overhead.
parallel Use noparallelto tell adpatch Oracle Applications patches
to run actions serially. are tested using parallel
mode.Use of noparallel
is discouraged.It may be
desupported in a later
Oracle Applications
release.
revcache Use norevcacheto tell adpatch With AD Mini-pack G,
not to load the package revision adpatch only loads the
cache. package revision cache
when package commands
without checkfilesyntax
are present in the patch
driver file, there is not
much reason to use
norevcache. Specifying
norevcachewill cause all
package commands
without checkfilesyntax
to run.
novalidate Use validateto tell adpatch to Useful for finding problems
connect to all registered Oracle with incorrectly-registered
Applications schemas. Oracle Applications
schemas or schemas with
invalid passwords.
Default Usage (options=) Comments
copy Use nocopyto turn off
these commands.
exec Use noexecto turn off
these commands.
exectier Use noexectierto turn off The nocopyportion,
these commands. nodatabaseportion, and
nogenerateportionoptions ignore
exectieractions.In some unusual
cases, you may need to specify
noexectieralong with no*portion
in order to disable exectieractions
that perform copy-, database-, or
generate-related logic.
Use noforcecopyto
change the default.
5/8
3/29/13 Document Display
change the default.
files in a patch to the Applications file
system without comparing the version
number of the patch files with existing
files.

genform genform Use nogenformto turn off

The genformcommand generates these commands.
form files.

genfpll genfpll Use nogenfpllto turn off

The genfpllcommand generates these commands.
forms PL/SQL library files.

gengpll gengpll Use nogengpllto turn off

The gengpllcommand generates these commands.
Oracle Graphics PL/SQL library files.

genmenu genmenu Use nogenmenuto turn off

The genmenucommand generates these commands.
forms menu files.

genmesg genmesg Use nogenmesgto turn off

The copycommand generates Oracle these commands.
Applications message files.

genogd genogd Use nogenogdto turn off

The genogdcommand generates these commands.
Oracle Graphics files.

genrep genrep Use nogenrepto turn off

The genrepcommand generates these commands.
reports files.

genrpll genrpll Use nogenrpllto turn off

The genrpllcommand generates these commands.
reports PL/SQL library files.

genwfmsg genwfmsg Use nogenwfmsgto turn off

The genwfmsgcommand generates these commands.
Workflow resource files.

jcopy jcopy Use nojcopyto turn off

The jcopycommand updates Java these commands.
class files.

libin libin Use nolibinto turn off

The libincommand copies files into these commands.
the product library.

libout libout Use noliboutto turn off You must also specify nolibinand
The liboutcommand extracts files these commands. nocopyif you specify nolibout.
from the product library.

link link Use nolinkto turn off

The linkcommand relinks these commands.
executables with the Oracle server.

makedir makedir Use nomakedirto turn off

The makedircommand creates an these commands.
empty directory.

sql sql Use nosqlto turn off these

The sqlcommand runs SQL scripts. commands.

Section 4: Command Line Options For One or More AD Utilities

https://support.oracle.com/epmos/faces/ui/km/SearchDocDisplay.jspx?_adf.ctrl-state=18z88yi99f_69 6/8
3/29/13 Document Display
abandon=y

Used by: adpatch, adadmin

Tells AD utilities to abandon an existing non-interactive session. Can be used only when
Purpose:
interactive=n is also specified..
Valid values: y or n.
Default value: n, meaning that the last utility run non-interactively did not 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 AD utility questions. Normally used
Purpose:
in non-interactive mode.
Valid values: A fully-qualified filename.Must be under the $APPL_TOP/admin/ directory.
Default value: none, meaning that no defaults file is used.
Example adpatch 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
Purpose:
wait in a loop to spawn a specified range of workers on the current machine.
Valid values: y
none, meaning that adctrl does not operate in Distributed AD mode. Instead, it
Default value:
brings up its standard menu.
Example adctrl distributed=y

interactive=y|n

Used by: adpatch, adadmin

Purpose: Tells AD utilities whether to run in interactive mode or non-interactive mode.
Valid values: yor 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 workers to run on the current
Purpose:
machine.
Valid values: zero to total number of workers (max=999)
Default value: none, meaning that all workers will run on the current machine
Example adpatch workers=10 localworkers=5

menu_option=menu-option-value

Used by: adadmin, adctrl

When running one of these utilities non-interactively, used to connect the
Purpose:
actions in a defaults file with a specific menu item.
See list of menu options in the description of these utilities in Oracle
Valid values: Applications Maintenance Utilities. Must be used with interactive=n and
defaultsfile=.
Default value: N/A
adctrl interactive=n
defaultsfile=$APPL_TOP/admin/prod/ctrldefs.txt
Example
menu_option=SHOW_STATUS

parallel_index_threshold=parallel-index-threshold-value

https://support.oracle.com/epmos/faces/ui/km/SearchDocDisplay.jspx?_adf.ctrl-state=18z88yi99f_69 7/8
3/29/13 Document Display
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 DML. If
Purpose:
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 with parallel workers and
Valid values:
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 non-interactive mode.Only
Purpose:
valid when interactive=nis also specified.
Valid values: yor n
n, meaning that the utility run in non-interactive mode will expect to run a
Default value:
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-interactive
Purpose:
session when a job fails.
Valid values: yor 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 used in non-interactive
Purpose:
mode.
Valid values: 1 to 99, inclusive
Default value: none, meaning that the program will prompt for the number of workers to run
Example adpatch workers=6

Section 5: Available Documentation

Oracle Applications Maintenance Utilities

Oracle Applications Maintenance Procedures

Change Log
Date Description

This note is for external release. In addition,

April 2, 2010 customers can refer to the Oracle Applications
Maintenance Utilities guide.

Apr 02, 2010 Created Note for R12

Note 1078973.1 by Oracle Applications Development

Copyright� 2010 Oracle Corporation
Last updated: Fri Apr 2, 2010

https://support.oracle.com/epmos/faces/ui/km/SearchDocDisplay.jspx?_adf.ctrl-state=18z88yi99f_69 8/8