Oracle Applications

AD Procedures Guide

Release 11i (11.5.7)

May 2002
Part No. A96516-01
Oracle Applications, AD Procedures Guide, Release 11i (11.5.7)

Part No. A96516-01

Copyright © 2000, 2002, Oracle Corporation. All rights reserved.

Primary Author: Yun Shaw

Contributing Authors: Subash Chadalavada, Venkat Damerla, Carole Eubanks, Miles Fender, Michael
Fiore, William Greene, My-Xuan Ho, Matthew Lobaugh, Rick Lotero, Kent Noble, Andrew Rist, Greg
Seiden

The Programs (which include both the software and documentation) contain proprietary information of
Oracle Corporation; they are provided under a license agreement containing restrictions on use and
disclosure and are also protected by copyright, patent and other intellectual and industrial property
laws. Reverse engineering, disassembly or decompilation of the Programs, except to the extent required
to obtain interoperability with other independently created software or as specified by law, is prohibited.

The information contained in this document is subject to change without notice. If you find any problems
in the documentation, please report them to us in writing. Oracle Corporation does not warrant that this
document is error-free. Except as may be expressly permitted in your license agreement for these
Programs, no part of these Programs may be reproduced or transmitted in any form or by any means,
electronic or mechanical, for any purpose, without the express written permission of Oracle Corporation.

If the Programs are delivered to the U.S. Government or anyone licensing or using the programs on
behalf of the U.S. Government, the following notice is applicable:

Restricted Rights Notice Programs delivered subject to the DOD FAR Supplement are "commercial
computer software" and use, duplication, and disclosure of the Programs, including documentation,
shall be subject to the licensing restrictions set forth in the applicable Oracle license agreement.
Otherwise, Programs delivered subject to the Federal Acquisition Regulations are "restricted computer
software" and use, duplication, and disclosure of the Programs shall be subject to the restrictions in FAR
52.227-19, Commercial Computer Software - Restricted Rights (June, 1987). Oracle Corporation, 500
Oracle Parkway, Redwood City, CA 94065.

The Programs are not intended for use in any nuclear, aviation, mass transit, medical, or other inherently
dangerous applications. It shall be the licensee's responsibility to take all appropriate fail-safe, backup,
redundancy, and other measures to ensure the safe use of such applications if the Programs are used for
such purposes, and Oracle Corporation disclaims liability for any damages caused by such use of the
Programs.

Oracle is a registered trademark, and JInitiator, Oracle Discoverer, OracleMetaLink, Oracle Store, Oracle8,
Oracle8i, Oracle9i, PL/SQL, SQL*Net, and SQL*Plus are trademarks or registered trademarks of Oracle
Corporation. Other names may be trademarks of their respective owners.
 Contents

Send Us Your Comments .................................................................................................................. vii

Preface............................................................................................................................................................ ix
Intended Audience ................................................................................................................................ ix
Documentation Accessibility ............................................................................................................... ix
Structure................................................................................................................................................... x
Related Documents................................................................................................................................. x
Training and Support............................................................................................................................ xi
Conventions........................................................................................................................................... xii

1 Maintaining Your System

Analyzing the Database..................................................................................................................... 1-1
Compiling Invalid Database Objects ............................................................................................. 1-2
Pinning Database Objects................................................................................................................. 1-3
Generating Files .................................................................................................................................. 1-5
Recovering Disk Space ...................................................................................................................... 1-6
Managing Server Processes............................................................................................................... 1-7
Middle Tier Processes .................................................................................................................. 1-7
Database Tier Processes ............................................................................................................. 1-11

2 Patching Your System

Patch Types........................................................................................................................................... 2-1
Applying Patches ................................................................................................................................ 2-3
Prepare for the Patching Process................................................................................................ 2-3

iii
 Run AutoPatch .............................................................................................................................. 2-4
After Running AutoPatch............................................................................................................ 2-6
Applying Patches in a Multi-node System................................................................................ 2-8
Applying Patches Non-interactively ............................................................................................... 2-9
Creating a Defaults File................................................................................................................ 2-9
Applying a Single Patch Driver File .......................................................................................... 2-9
Applying a Standard Patch ....................................................................................................... 2-10
Applying a Non-standard Patch .............................................................................................. 2-10
Restarting a Non-interactive AutoPatch Session ................................................................... 2-12
Appplying Patches without Password Validation...................................................................... 2-12
Merging Patches ................................................................................................................................ 2-13
Backing Out Patches......................................................................................................................... 2-15

3 Analyzing Patch Information

Determining if a Patch was Applied............................................................................................... 3-1
Determining the Actions Performed by a Driver File ................................................................. 3-3
Determining if a Translation was Applied for a Specific Patch ................................................ 3-7
Migrating Patch History Information ............................................................................................. 3-9

4 Modifying Your System Configuration

Licensing Components ...................................................................................................................... 4-1
Run License Manager................................................................................................................... 4-1
License Products ........................................................................................................................... 4-4
License Country-specific Functionalities .................................................................................. 4-6
License Languages........................................................................................................................ 4-7
Review Licensed Products and Languages............................................................................. 4-10
License Off-cycle Products ........................................................................................................ 4-12
Converting to Multiple Organizations ......................................................................................... 4-15
Converting to Multiple Reporting Currencies............................................................................ 4-16
Adding a Node .................................................................................................................................. 4-17

5 Migrating Your System

Migrating an Oracle Applications Database ................................................................................. 5-1
Migrating a Single Instance to Real Applications Clusters........................................................ 5-2

iv
 Migrating an Oracle Applications File System............................................................................. 5-2
Moving Files on the Same Node ................................................................................................ 5-3
Migrating the File System to Another Platform....................................................................... 5-5
Migrating the Entire Oracle Applications File System............................................................ 5-6
Cloning Oracle Applications............................................................................................................ 5-7

6 Troubleshooting
Reviewing Worker Status.................................................................................................................. 6-1
Determining Worker Errors .............................................................................................................. 6-2
Handling a Failed Job ........................................................................................................................ 6-4
Interrupting a Hanging Worker Process......................................................................................... 6-5
Restarting a Failed or Terminated Worker ..................................................................................... 6-6
Restarting a Terminated Child Process........................................................................................... 6-7
Restarting After a Machine Crash ................................................................................................... 6-7
Shutting Down the Manager ............................................................................................................ 6-7
Reactivating the Manager ................................................................................................................. 6-8

Index

v
vi
 Send Us Your Comments
Oracle Applications, AD Procedures Guide, Release 11i (11.5.7)
Part No. A96516-01

We welcome your comments and suggestions on the quality and usefulness of this publication. Your
input is an important part of the information used for revision.
■ Did you find any errors?
■ Is the information clearly presented?
■ Do you need more information? If so, where?
■ Are the examples correct? Do you need more examples?
■ What features did you like most about this manual?

If you find any errors or have any suggestions for improvement, please indicate the document title
and part number, and the chapter, section, and page number, if available. Send comments to us by
email at [email protected]. If you would like a reply, please give your name, address, tele-
phone number, and (optionally) email address.

vii
viii
 Preface

AD Utilities Reference Guide and AD Procedures Guide make up the Maintaining Oracle
Applications Documentation Set. The AD Procedures Guide describes procedures for
maintaining the Oracle Applications file system and database using the
Applications DBA (AD) utilities. The AD Utilities Reference Guide provides specific
details on how to run the AD utilities.

Intended Audience
This book is intended for database administrators and system administrators who
need to perform Oracle Applications maintenance tasks.

Documentation Accessibility
Our goal is to make Oracle products, services, and supporting documentation
accessible, with good usability, to the disabled community. To that end, our
documentation includes features that make information available to users of
assistive technology. This documentation is available in HTML format, and contains
markup to facilitate access by the disabled community. Standards will continue to
evolve over time, and Oracle Corporation is actively engaged with other
market-leading technology vendors to address technical obstacles so that our
documentation can be accessible to all of our customers.
For additional information, visit the Oracle Accessibility Program web site at
http://www.oracle.com/accessibility/.

Accessibility of Code Examples in Documentation

JAWS, a Windows screen reader, may not always correctly read the code examples
in this document. The conventions for writing code require that closing braces

ix
 appear on an otherwise empty line. JAWS may not always read a line of text that
consists solely of a bracket or brace.

Accessibility of Links to External Web Sites in Documentation

This documentation may contain links to Web sites of other companies or
organizations that Oracle Corporation does not own or control. Oracle Corporation
neither evaluates nor makes any representations regarding the accessibility of these
Web sites.

Structure
This book contains the following chapters:
■ Chapter 1 describes general procedures to maintain Oracle Applications.
■ Chapter 2 describes procedures related to patching Oracle Applications.
■ Chapter 3 contains information on analyzing patch history information in
Oracle Applications.
■ Chapter 4 describes procedures to update the configuration of Oracle
Applications after the initial installation.
■ Chapter 5 describes procedures to migrate an Oracle Applications system.
■ Chapter 6 describes procedures for troubleshooting the AD utilities parallel
processes.

Related Documents
All Release 11i documentation is included on the Oracle Applications Document
Library CD, which is supplied in the Release 11i CD Pack. You can download some
soft-copy documentation from http://docs.oracle.com. You can also purchase
hard-copy documentation from the Oracle Store at http://oraclestore.oracle.com.

x
 If you are looking for... See these documents...
Additional information Oracle Applications Concepts
Upgrading Oracle Applications
Installing Oracle Applications
Maintaining Oracle Applications Documentation Set:
Oracle Applications AD Utilities Reference Guide
Oracle Applications Installation Update Notes*
Oracle Applications Release Notes*
Oracle Applications NLS Release Notes*
Oracle Applications System Administrator’s Guide
Oracle Self-Service Web Applications Implementation Manual
Oracle Workflow Guide
Oracle Applications Character Mode to GUI Menu Path Changes
Oracle Application Object Library/Workflow Technical Reference Manual
Application-specific Oracle Applications user’s guides
features Oracle Applications implementation manuals
Multiple Organizations in Oracle Applications
Multiple Reporting Currencies in Oracle Applications
Oracle Applications Supplemental CRM Installation Steps
Information about custom Oracle Applications User Interface Standards for Forms-based Products
development Oracle Applications Developers’ Guide
Database information Oracle8i Concepts
Oracle8i Backup and Recovery Guide
Oracle8i Reference
Oracle8i Designing and Tuning for Performance
Oracle8i National Language Support Guide
*Available only on OracleMetaLink

Update or patch readme files may contain information about new documentation
that you can download.

Note: Documentation associated with this release was current as

of the time it was released.

Training and Support

Oracle offers a complete set of training courses and multi-level support services.

Training
You can attend training courses at any Oracle Education Center, arrange for trainers
to teach at your facility, or use Oracle Learning Network (OLN) — Oracle
University’s online education utility. Oracle training professionals can also develop

xi
 custom courses using your organization structure, terminology, and data as
examples.

Support
The Oracle support team includes your Technical Representative and Account
Manager. It also includes Oracle consultants and support specialists who have
expertise in your business area, and in managing an Oracle8i server and your
hardware and software environment.
OracleMetaLink is a self-service, web-based support connection, which is
maintained by Oracle Support Services 24 hours a day, 7 days a week. Use it to
obtain information and advice from technical libraries and forums, download
patches, look at bug details, and create or update TARs. Register at
http://metalink.oracle.com, and check for updates and information before you
install or upgrade your Oracle Applications. The Start Here CD also contains links to
the various resources on OracleMetaLink.

Conventions
The following conventions are used in this book:

Convention Meaning
UNIX: Indicates platform-specific information. This guide contains
Windows: information for both UNIX and Windows platforms.
$ or C:\> Represents the platform-specific command prompt. Your
prompt may differ.
Monospace text Represents command line text. Type this text exactly as shown.
<> Text enclosed in angle brackets represents a variable. Substitute
a value for the variable text. Do not type the brackets.
[] Encloses optional items or indicate a function key. Do not type
the brackets.
| Represents an or option among several options. You must enter
only one of the options. Do not type the vertical bar.
\ In examples of commands you type online, a backslash at the
end of a line signifies that you must type the entire command on
one line. Do not type the backslash.

Special notes alert you about particular information within the body of the book.
They include Additional Information, Attention, Note, and Warning.

xii
 1
Maintaining Your System

This chapter contains general procedures for proper maintenance of the Oracle
Applications system. It contains the following sections:
■ Analyzing the Database
■ Compiling Invalid Database Objects
■ Pinning Database Objects
■ Generating Files
■ Recovering Disk Space
■ Managing Server Processes

Analyzing the Database

In releases prior to 11i, the Oracle Applications initialization parameters set the
Oracle Server to use rule-based optimization (RBO) by default when executing a
SQL statement. Oracle Applications Release 11i is run in the cost-based
optimization mode (CBO). To properly configure the database server to use
cost-based optimization, analyze the database and gather statistics about Oracle
Applications database objects in these situations:
■ For a new system after it has a significant amount of transaction data stored
■ Before an upgrade (as either a Category 1 or Category 3 step)
■ After running AutoUpgrade (as a Category 4 step)
■ As part of system maintenance, approximately once a month

Maintaining Your System 1-1

Compiling Invalid Database Objects

Note: Identify and continually update the frequency for gathering

all statistics and for specific products, based upon usage.

To analyze the database, run the Gather Schema Statistics concurrent program:
1. Log on to Oracle Applications with the System Administrator responsibility.
2. Navigate to the Submit Request window (Request > Run).
3. Submit the Gather Schema Statistics program.
If schema name is set to ALL, statistics are gathered for all Oracle Applications
schemas (having an entry in the FND_PRODUCT_INSTALLATIONS table). In
addition to gathering index and table-level statistics, the procedure also gathers
column-level histogram statistics for all columns listed in the FND_HISTOGRAM_
COLS table.

Additional Information: See Cost-Based Optimization in Oracle

Applications in the Oracle Applications System Administrator’s Guide.

Compiling Invalid Database Objects

Compiling Oracle Applications objects in the APPS schema is most effective when
run:
■ Immediately after an upgrade
■ After a patch is applied, especially one that affects the APPS schema, that is
the patch contains a database driver (for multiple patches, compile the
objects once, after applying all the patches)
■ Before converting to Multi-Org or Multiple Reporting Currencies (MRC)
■ After performing an export/import (migration)
■ When doing custom development in the APPS schema
■ After custom packages are moved to the APPS schema
Use AD Administration to perform the following steps:
1. Validate APPS schema.
Select the "Validate APPS schema" task from the Maintain Applications
Database Objects menu. This task runs a SQL script (advrfapp.sql) to verify the

1-2 AD Procedures Guide

 Pinning Database Objects

integrity of the APPS schema. Review the output file from this task for any
invalid database objects.

Additional Information: See AD Administration in the AD Utilities

Reference Guide.

2. Recreate grants and synonyms for APPS schema.

The output file from Step 1 may reveal missing grants and synonyms for the
APPS schema. If so, run AD Administration and select the "Recreate grants and
synonyms" for the APPS schema task from the Maintain Applications Database
Objects menu.

Note: To set up grants and synonyms for the MRC schema, choose
the Maintain MRC task specifically from the Database Objects
menu after compiling the APPS schema and fixing any issues.

3. Compile APPS schema.

If the output file from Step 1 reveals that invalid database objects exist in the
APPS schema, run AD Administration and select the "Compile APPS schema"
task.

Note: This task compiles objects owned and referenced by the

APPS schema only. Use a separate utility or script (such as the
utlrp.sql script provided with the database in the $ORACLE_
HOME/rdbms/admin directory) to compile all objects within a
database.

Pinning Database Objects

Oracle Applications requires space in the Oracle System Global Area (SGA) to
execute stored packages and functions. If SGA space is fragmented, there may not
be enough for a package or function. Pre-allocate space in the SGA shared pool for
packages, functions, and sequences by "pinning" them.

Maintaining Your System 1-3

Pinning Database Objects

Attention: Run these scripts every time packages or sequences are

patched using AutoPatch (when the patch readme file tells you to
do so), or any time after objects are invalidated, either because of
patching or customizations.

The ADXGNPIN.sql script pins packages and functions in the APPS schema, while
ADXGNPNS.sql pins sequences in the base product schemas. Both scripts take the
name of a schema as an argument, or % for all schemas. ADXGNPIN.sql generates
and invokes another SQL file, ADXSPPIN.sql. ADXGNPNS.sql generates and runs
ADXSPPNS.sql.
1. Create the appsutil/admin directory in the ORACLE_HOME of the database
server.
2. Copy ADXGNPIN.sql and ADXGNPNS.sql from the AD_TOP/sql directory of
the admin server to this directory.
3. Set the environment to point to the ORACLE_HOME for the database server.
Access the database server directly.
4. Go to the directory created in Step 1 and run ADXGNPIN.sql and
ADXGNPNS.sql from SQL*Plus:
sqlplus <SYS username>/<SYS password> @ADXGNPIN.sql <APPS schema name>

sqlplus <SYS username>/<SYS password> @ADXGNPNS.sql <schema name>

Note: The MRC schema contains some definer rights packages. If

the system uses MRC, run ADXGNPIN.sql in the MRC schema.

We also provide a script that can be run at any time to query for objects stored in the
shared pool. It shows the objects known to the SGA and the size that they consume
in the SGA. The output file is ADXCKPIN.lst.

UNIX:
$ cd $APPL_TOP/admin/<SID>/out
$ sqlplus <SYSTEM username>/<SYSTEM password> @$AD_TOP/sql/ADXCKPIN.sql

Windows:
C:\> cd %APPL_TOP%\admin\<SID>\out
C:\> sqlplus <SYSTEM username>/<SYSTEM password> @%AD_TOP%\sql\ADXCKPIN.sql

1-4 AD Procedures Guide

 Generating Files

Generating Files
AD Administration automates the generation of forms, reports, graphics, message
and product JAR (Java archive) files. Generate files when you suspect an issue with
a particular file or set of files. For example, if users are not able to use a certain
General Ledger form, regenerating the form file may resolve the issue.
As patches are applied to Oracle Applications, files belonging to unlicensed
products are not generated. When licensing an additional product, generate all
product files before using the product.
To generate files, perform the following:
1. Determine the file types that require generation.
2. Log on as applmgr and set the environment.

Additional Information: See Setting the Environment in the AD

Utilities Reference Guide.

3. Start AD Administration. The main menu appears.

Additional Information: See AD Administration in the AD Utilities

Reference Guide.

4. Go to the Maintain Applications Files menu and select the task for the type of
files you want to generate.
■ The generate form files, report files and graphic files options allow you to
select the files to generate. You can select an individual file, a set of files, or
all files of the selected type.
■ The generate product JAR files option allows you to generate all files for all
products, or only JAR files that are out of date.
■ The generate message files option generates all message files for all
products.
5. Repeat the generation task on each server node that contains the files, if the
Oracle Applications system contains multiple nodes.
6. Review the AD Administration log file for any warnings or errors.

Maintaining Your System 1-5

Recovering Disk Space

Recovering Disk Space

If you need to recover disk space, compress or delete obsolete Oracle Applications
product files. Oracle recommends doing this only if there is no other way to
increase available disk space. Always back up files before deleting them and keep
the backup readily available in case you need to restore files.

Additional Information: See File System in Oracle Applications

Concepts.

Log and output files

After successfully completing an upgrade of Oracle Applications or a maintenance
task with an AD utility, you can compress, archive, or delete the files in the
following directories, where <SID> is the name of the database instance in which
the current product group is installed:

UNIX:
The files in $APPL_TOP/admin/<SID>/log and
$APPL_TOP/admin/<SID>/out.

Windows:
The files in %APPL_TOP%\ admin\<SID>\log and
%APPL_TOP%\admin\<SID>\out.
These directories contain log and output files, respectively, for AutoUpgrade and
other Oracle Applications utilities. Do not delete the directories.

Attention: Log files may contain passwords. Back up these files to

a secure location.

Upgrade files
If you are not upgrading Oracle Applications from a prior release, or all product
groups have been upgraded to the current release, then you can compress, archive,
or delete the files in $APPL_TOP/admin/preupg (UNIX) or the files in %APPL_
TOP%\admin\preupg (Windows).
This directory contains SQL*Plus and other files used to prepare products for an
upgrade to the current software release.

1-6 AD Procedures Guide

 Managing Server Processes

Attention: Do not remove any files under <PROD>_TOP/admin.

They are used by AD utilities such as AutoPatch and AD
Administration.

AutoPatch backup files

After running AutoPatch to update Oracle Applications, you can compress, archive,
or delete old files that have been backed up in the patch subdirectory. Delete them
only after verifying that the patch was successful and fully testing the patched
functionalities.

Additional Information: See AutoPatch in the AD Utilities Reference

Guide.

Managing Server Processes

Rapid Install sets up and configures the server processes for you during installation.
It stores a script for each middle (application) tier process in the
COMMON_TOP/admin/scripts/<SID> directory, where <SID> is the name of the
database instance, and for the database tier processes in the database server
ORACLE_HOME/appsutil/scripts directory. You use these scripts to start or stop
server processes of the Oracle Applications system.

Note: All scripts in this section contain system-specific

information. If you modify your system from the Rapid Install
defaults, the scripts may fail. You may need to edit the scripts
before rerunning them.

Additional Information: See NLS-independent Application

Servers in Oracle Applications Concepts.

Middle Tier Processes

Oracle Applications provides scripts for the following middle tier processes:
■ Forms server listener
■ Forms Metrics server
■ Forms Metrics client

Maintaining Your System 1-7

Managing Server Processes

■ Reports server
■ Report Review Agent
■ Concurrent managers
■ HTTP server

Forms server listener

The forms server listener defines the Oracle Forms Cartridge parameters. To
start/stop the listener, log on to the system as applmgr on the forms server node.
Then, type:

UNIX:
adfrmctl.sh [start|stop]

Windows:
adfrmctl.cmd [start|stop]

Forms Metrics server

The Metrics Server keeps track of all forms servers in a given pool of forms servers
and directs each form execution request to the least loaded server that is able to
service requests in the given pool. To start/stop the Metrics Server, log on to the
system as applmgr on the forms server node. Then, type:

UNIX:
adfmsctl.sh [start|stop]

Windows:
adfmsctl.cmd [start|stop]

Forms Metrics client

The Metrics Client sends load information, such as the number of forms processes
that are currently running on that machine, to the Metrics Server. The Metrics Client
runs on each machine with a forms server. To start/stop the Metrics Client, log on
to the system as applmgr on the forms server node. Then, type:

UNIX:
adfmcctl.sh [start|stop]

Windows:
adfmcctl.cmd [start|stop]

1-8 AD Procedures Guide

 Managing Server Processes

Reports server
The reports server processes requests to execute a report and returns the output of
the report. To start/stop the reports server, log on as applmgr on the concurrent
processing server node and type:

UNIX:
adrepctl.sh [start|stop]

Windows:
adrepctl.cmd [start|stop]

Note: This script sets the DISPLAY variable to the default value
defined when running Rapid Install.

Report Review Agent

Oracle Applications uses the Report Review Agent to view concurrent processing
files online. This utility is on the concurrent processing server and uses Net8 to
communicate with the forms server. Rapid Install sets up and configures the Report
Review Agent for you during installation. It names the Net8 listener APPS_<SID>
and performs the following tasks:
■ Configures network files
■ Verifies file permissions
To start/stop the Report Review Agent, log on as applmgr on the concurrent
processing server node and type:

UNIX:
adalnctl.sh [start|stop] <listener_name>

Windows:
adalnctl.cmd [start|stop] <listener_name>

The listener should always be the APPS listener name or the script may terminate
another listener.

Concurrent managers
Rapid Install sets up and starts the concurrent managers for you. It also provides a
script, so you can restart them later, if needed. You can use this script to start/stop

Maintaining Your System 1-9

Managing Server Processes

the concurrent manager for a database. During the set up process, Rapid Install
performs the following tasks:
■ Sets up electronic mail messaging
■ Creates common log and output directory and log and output files in each
product top directory
■ Defines startup parameters
■ Restricts access
To run the script, log on as applmgr on the concurrent processing server node and
type:

UNIX:
adcmctl.sh [start|stop] <APPS username>/<APPS password>

Windows
adcmctl.cmd [start|stop] <APPS username>/<APPS password>

Additional Information: See Concurrent Managers in the Oracle

Applications System Administrators Guide.

Note: This script sets the DISPLAY variable to the default value
defined when running Rapid Install.

HTTP server
The Oracle HTTP server processes URL requests to execute forms based
Applications and Self-Service Web Applications. Rapid Install sets up and starts the
HTTP server. It also provides a script so you can restart it later, if necessary. To
start/stop the HTTP server, log on to the system as applmgr on the web server
node. Then, type:

UNIX:
adapcctl.sh [start|stop]

Windows:
adapcctl.cmd [start|stop]

1-10 AD Procedures Guide

 Managing Server Processes

Start all middle tier server processes

Oracle Applications provides a single script to start all server processes on the
middle tier. To run this script, log on to the system as applmgr. Then, type:

UNIX:
adstrtal.sh <APPS username>/<APPS password>

Windows:
adstrtal.cmd <APPS username>/<APPS password>

Stop all middle tier server processes

Oracle Applications provides a single script to stop all server processes on the
middle tier. To run this script, log on to the system as applmgr. Then, type:

UNIX:
adstpall.sh <APPS username>/<APPS password>

Windows:
adstpall.cmd <APPS username>/<APPS password>

Database Tier Processes

Oracle Applications provides scripts for the following database tier processes:
■ Net8 listener for Oracle8i server
■ Oracle8i server

Net8 listener for Oracle8i server

Rapid Install sets up and configures the Net8 database listener. It also provides a
script so you can start/stop the listener, if necessary. This script is in the database
server ORACLE_HOME under appsutil/scripts. As the oracle user on the database
server, type:

UNIX:
addlnctl.sh [start|stop] <listener_name>

Windows:
addlnctl.cmd [start|stop] <listener_name>

For example, the oracle user would start the Net8 listener with the following
command:

Maintaining Your System 1-11

Managing Server Processes

UNIX:
addlnctl.sh start PROD

Windows:
addlnctl.cmd start PROD

Additional Information: See the Oracle Net8 Administrator’s Guide.

Oracle8i server
Oracle Applications provides a script so you can start/stop the database server, if
necessary. This script is in the database server ORACLE_HOME under
appsutil/scripts. As the oracle user on the database server, type:

UNIX:
addbctl.sh [start|stop] {immediate|abort|normal}

Windows:
addbctl.cmd [start|stop] {immediate|abort|normal}

For example, the oracle user would shut down the database with the following
command:

UNIX:
addbctl.sh stop normal

Windows:
addbctl.cmd stop normal

1-12 AD Procedures Guide

 2
Patching Your System

This chapter contains information about applying patches to the Oracle

Applications system. It contains the following sections:
■ Patch Types
■ Applying Patches
■ Applying Patches Non-interactively
■ Appplying Patches without Password Validation
■ Merging Patches
■ Backing Out Patches

Patch Types
Throughout the course of the Oracle Applications lifecycle, patches are applied for a
number of reasons. These include:
■ Updating to a higher maintenance level (maintenance pack)
■ Applying the latest product enhancements (mini-pack)
■ Adding a new feature or functionality
■ Fixing an existing issue
All Oracle Applications patches update the file system, or the database, or both and
are available from OracleMetaLink. The patch types are:

Patch Type Description

Bug fix Fixes an existing issue.

Patching Your System 2-1

Patch Types

Patch Type Description

New feature Adds new functionality.
Interoperability Contains Oracle Applications files and database objects to make
the current version of Oracle Applications compatible with a
newer version of the database or a technology stack component,
for example, Oracle 8.1.7 interoperability with Applications
Release 11.0.
Diagnostic Released specifically to determine the source of an issue. A
diagnostic patch does not fix the issue.
Translation Contains Oracle Applications files that have been translated
from English to one of the other languages supported by Oracle
Applications. The patch may also execute tasks to load or update
data in the database, particularly the _TL translation tables.
Upgrade Fixes a problem with an upgrade or improves the performance
of an upgrade from a previous major release, such as 10.7 or 11.0.
Documentation Updates Oracle Online Help. When applying a product
mini-pack or a stand-alone patch that adds a new feature, review
the Features Summary Matrices on OracleMetaLink for the
coordinating documentation patch.

Patches are released in the following formats:

Patches Description
Stand-alone Fixes a specific issue or provides new functionality.
High-priority Defined by Oracle Development to have broad enough impact
so that it merits a review for application by all customers who
have installed a particular product.
Mini-pack A consolidation of all high-priority and stand-alone patches for
a product. The naming convention is 11i.<product>.
<mini-pack letter> such as 11i.AD.F. Subsequent mini-packs
(those with higher <mini-pack letter>) supersede previous
versions. Mini-packs are cumulative.
Family pack A consolidation of a set of mini-packs and high-priority
stand-alone patches for a product family.
Family consolidated All upgrade-related, high-priority patches consolidated from all
upgrade patch the products within a product family. Family consolidated
upgrade patches are released as needed. The Oracle Applications
Release Notes lists the most recent family consolidated upgrade
patches.

2-2 AD Procedures Guide

 Applying Patches

Patches Description
Maintenance pack A consolidation of all product mini-packs. The maintenance
release updates a system to a new point release of Oracle
Applications, such as 11.5.7.

Applying Patches
Updates to one or more of the servers (admin, concurrent processing, database,
forms, or web) are applied on the database tier, or the application (middle) tier, or
both. In general, updates may include, or require, changes to Oracle Applications,
the Oracle Applications technology stack, the Oracle database and related
components. This section focuses on patches applied to the Oracle Applications file
system and database.

Prepare for the Patching Process

Once you have determined the patches to apply, download them from
OracleMetaLink and perform the following steps:
1. Log on as applmgr and set the environment.

Additional Information: See Setting the Environment in the AD

Utilities Reference Guide.

2. Place the patches in a designated patch top directory.

If a designated patch top directory does not exist, create one. Placing all patches
in a designated area and keeping a log of the patches applied helps to
streamline the maintenance of the Oracle Applications system.
3. Unzip the patches.

Note: Do not use the patch subdirectory under the <PROD>_TOP

directory to unzip patches.

4. Review the readme files.

The readme file (README.txt) is located in the directory created by the
unzipping process and contains instructions for applying the patch. There may
be manual steps to perform before and after applying the patch.
5. Merge the patches.

Patching Your System 2-3

Applying Patches

When applying multiple patches, use AD Merge Patch to merge the patches.

Additional Information: See Merging Patches in this chapter.

6. Review the driver files.

Apply driver files in this order:
■ copy driver (c<patchnum>.drv)
■ database driver (d<patchnum>.drv)
■ generate driver (g<patchnum>.drv)
7. Shut down services.
When applying a patch that modifies or relinks files on a concurrent processing
server, shut down the concurrent managers. When applying a patch that
modifies or relinks files on a web server, shut down the web server listeners.
When relinking files on a forms server, have all Oracle Applications users log
off before proceeding.

Attention: A patch is not completely applied until all portions

have been run successfully. Accessing any part of Oracle
Applications while a patch is being applied may result in errors
until the update is completed.

The following steps are for Windows users only:

8. Refer to the Release Maintenance Tools section in Oracle Applications Installation
Update Notes Release 11i for Windows NT/2000 to insure all necessary tools for
release maintenance on Windows are installed properly.
9. Ensure that %JAVA_TOP%\apps.zip and %JAVA_TOP%\loadjava.zip are
included in the set classpath statement of %APPL_TOP%\admin\adovars.cmd.
10. Verify that the MKS toolkit directory and the gnumake directory appear before
the WINNT and WINNT\System32 directories in the system path.

Run AutoPatch
Start AutoPatch in normal mode from the patch directory, which is the directory the
patch files where unloaded. Use the adpatch command.

2-4 AD Procedures Guide

 Applying Patches

When AutoPatch prompts for the driver name, specify the copy driver. After the
copy driver is successfully applied, apply the database driver (if the patch includes
one). Then, apply the generate driver (if the patch includes one). If the Oracle
Applications system contains multiple nodes, see the Applying Patches in a
Multi-node System section in this chapter for the order of applying the drivers.
After each driver is applied successfully, AutoPatch updates the patch history
database with details of the patching session.

Additional Information: See Patch History Database in the AD

Utilities Reference Guide.

Copy Driver
When applying the copy driver, AutoPatch:
■ Extracts the appropriate files from each product’s C library.
■ Compares the extracted object modules with their corresponding files in the
patch directory. It also makes this type of comparison with files such as forms,
reports, and SQL scripts.
■ If a file in the patch directory is a more recent version than the product’s current
file, AutoPatch backs up the product’s current file into a subdirectory of the
patch directory. For example, if <patch_dir> is the patch directory, <env_name>
is the Applications Environment name, <appl_top_name> is the APPL_TOP
name, and <prod> is the name of the product being patched, it backs up:
<PROD>_TOP/<subdir(s)>/<old_file_name>

to

<patch_dir>/backup/<env_name>/<appl_top_name>/ \
<prod>/<subdir(s)>/<old_file_name>

Note: The Applications Environment name and the APPL_TOP

name are determined during the Rapid Install installation process.

■ Replaces each product’s outdated files with newer files from the patch
directory.
■ Applies changed Java class files and regenerates JAR files as needed.
■ Loads the new object modules into the C libraries.

Patching Your System 2-5

Applying Patches

■ Relinks the Oracle Applications products with the operating system, Oracle
server, and other Oracle products libraries.
■ Copies any specified HTML or media files to their respective destinations.

Database Driver
When applying the database driver, AutoPatch:
■ Determines whether the action was performed in a previous patch.
■ Runs SQL scripts and exec commands, which change Oracle Applications
database objects. By default, AutoPatch does this in parallel.
■ Performs Invoker Rights processing if the patch contains a package command.
AutoPatch performs Invoker Rights processing in serial mode when the patch is
applied serially and in parallel mode when it is applied in parallel.

Note: Invoker Rights processing ignores custom code that does

not have header information in a format identical to the one
defined by Oracle Applications coding standards.

Additional Information: See Naming Standards and Definitions in

the Oracle Applications Developers Guide.

Generate Driver
When applying the generate driver, AutoPatch generates Oracle forms files, reports
files, and graphics files.

After Running AutoPatch

After completing the patch process, perform the following tasks:
1. Review log files.
Review the AutoPatch log file after the application of each driver file for
warnings or errors. It is located in APPL_TOP/admin/<SID>/log and the
default name is adpatch.log. In addition, some patch tasks may create separate
log files in the same directory. If the patching process used multiple workers,
each worker creates its own log file.

2. Review customizations.

2-6 AD Procedures Guide

 Applying Patches

If AutoPatch displayed a message indicating that previously registered,

customized files will be replaced by the patch, review those files to determine if
customizations need to be re-applied or merged.
3. Review AutoPatch backup files.
After successfully patching all nodes and properly testing the system, delete the
backup copies of files from the patch subdirectory trees to recover disk space, as
necessary. However, we recommend retaining these files if space is available.
Check for customized files before deleting these backups. Register customized
files in the applcust.txt file in the APPL_TOP/admin directory. If these backups
contain customizations, reapply them before deleting the backup copies.

Additional Information: See Recovering Disk Space in Chapter 1.

4. Maintain Multiple Reporting Currencies schema.

If the system uses Multiple Reporting Currencies functionality, choose to
maintain the MRC schema using AD Administration after running any patch
driver file that updates database objects. AutoPatch displays a reminder
message when the patch completes, if it detects MRC functionality in the
database.

Additional Information: See AD Administration in the AD Utilities

Reference Guide.

5. Pin SGA packages.

If AutoPatch modified any Oracle Applications database objects, run
ADXGNPIN.sql and ADXGNPNS.sql to pin new packages and sequences in the
Oracle System Global Area. These scripts are located in AD_TOP/sql.

Additional Information: See Pinning Database Objects in

Chapter 1.

6. Restart server processes.

After verifying the successful application of the patch, start all server processes
and allow users to access the system.

Patching Your System 2-7

Applying Patches

Applying Patches in a Multi-node System

The configuration of Oracle Applications is multi-node if one or more servers are
installed on separate nodes (machines) or on separate APPL_TOPs. In a multi-node
system, run AutoPatch on each node to install or patch the necessary files.
Specifically:
1. Run the copy driver of the patch (c<patchnum>.drv) on every node containing
one or more of the files being replaced by the patch or, if in doubt, apply the
copy driver on all nodes, starting with the admin server.
2. Run the database driver of the patch (d<patchnum>.drv) once, from the admin
server only.
3. Run the generate driver of the patch (g<patchnum>.drv) on every node
containing one or more of the files to be generated or, if in doubt, apply the
generate driver on all nodes.
For example, if the system has two nodes, with an admin server, concurrent
processing server and database server on one node and a forms server and web
server on the other, apply the drivers as follows:
1. Shut down concurrent managers and other services.

Note: If the extent of the patch actions are unknown, shut down
all services and ensure no users are on the system before applying
any portion of the patch. Some patches, such as those that update
online help, do not require any system downtime.

2. Apply the copy driver to node 1 (admin, concurrent processing, and database
servers).
3. Start the concurrent managers.
4. Apply the copy driver to node 2 (forms and web servers).
5. Apply the database driver to node 1.
6. Apply the generate driver to node 1.
7. Apply the generate driver to node 2.
8. Start services and restart the web server, if necessary.

2-8 AD Procedures Guide

 Applying Patches Non-interactively

Attention: Do not run multiple sessions of AutoPatch

simultaneously.

Applying Patches Non-interactively

AutoPatch can run all the patch drivers in a patch without user intervention. When
a patch top location is specified, AutoPatch locates and runs all patch drivers that
are specific to the patch being applied.

Creating a Defaults File

Before running AutoPatch non-interactively, create an AutoPatch defaults file for
the current system.
1. Specify defaultsfile=<Defaults File Name> on the AutoPatch command line.
The defaults file must be located in APPL_TOP/admin/<SID>.
For example:
UNIX:
$ adpatch defaultsfile=$APPL_TOP/admin/<SID>/def.txt

Windows:
C:\> adpatch defaultsfile=%APPL_TOP%\admin\<SID>\def.txt

2. Run AutoPatch up to the point where it asks for the directory where the Oracle
Applications patch has been unloaded. Type abort at this prompt.
3. Verify that the defaults file exists.
Once an AutoPatch defaults file is created, you can run AutoPatch non-interactively.
Here are some examples:

Applying a Single Patch Driver File

It is possible to apply just a single patch driver file non-interactively using
AutoPatch. Assume the following:
■ Defaults file is $APPL_TOP/admin/testdb1/def.txt (UNIX) or
%APPL_TOP%\admin\testdb1\def.txt (Windows).
■ Copy driver for patch 123456, which is located in the patch directory under the
APPL_TOP.

Patching Your System 2-9

Applying Patches Non-interactively

■ Three parallel workers.

■ AutoPatch log file name is 123456.log.
The AutoPatch command would be:

UNIX:
$ adpatch defaultsfile=$APPL_TOP/admin/testdb1/def.txt logfile=123456.log \
patchtop=$APPL_TOP/patch/123456 driver=c123456.drv workers=3 interactive=no

Windows:
C:\> adpatch defaultsfile=%APPL_TOP%\admin\testdb1\def.txt logfile=123456.log \
patchtop=%APPL_TOP%\patch\123456 driver=c123456.drv workers=3 interactive=no

Applying a Standard Patch

A standard patch is one where the patch top value ends in a 6- to 8-digit number.
For example, patchtop=$APPL_TOP/ patch/123456 (UNIX), or
patchtop=%APPL_TOP%\patch\123456 (Windows). To apply a standard patch to
the APPL_TOP and database non-interactively:
■ Specify patchtop=<value> on the AutoPatch command line.
■ Do not specify driver=<value> on the AutoPatch command line.
AutoPatch assumes the patch is a standard patch, and it runs the standard patch
driver files in the standard order without prompting for the patch driver file names.
It looks for c<patchnum>.drv, d<patchnum>.drv, and g<patchnum>.drv.
For example:

UNIX:
$ adpatch defaultsfile=$APPL_TOP/admin/testdb1/def.txt logfile=patch123456.log \
patchtop=$APPL_TOP/patch/123456 workers=3 interactive=no

Windows:
C:\> adpatch defaultsfile=%APPL_TOP%\admin\testdb1\def.txt \
logfile=patch123456.log patchtop=%APPL_TOP%\patch\123456 \
workers=3 interactive=no

Applying a Non-standard Patch

A non-standard patch is one where the patch structure is standard, but the naming
convention is not. That is, the last component of the patch directory is not a 6- to
8-digit number, or the patch driver files are not named *<patchnum>.drv, or both.

2-10 AD Procedures Guide

 Applying Patches Non-interactively

Oracle Applications sometimes ships non-standard patches, or they may be created

when using AD Merge Patch.
To apply a non-standard patch non-interactively, supply the following information
to AutoPatch:
■ The names of the patch driver files.
■ The order in which the patch driver files should be run (The README.txt
describes the proper order).
■ Optionally, the types of patch driver files (copy, database, or generate). This is
useful because AutoPatch knows not to run a database driver file unless the
current APPL_TOP implements the admin server.
Use the AutoPatch command line argument driver=<values>, where <values> is a
comma-separated list of the patch driver files you want AutoPatch to run. For
example, suppose you want AutoPatch to apply the following patch driver files in
the order listed:
■ my_drv1.drv (copy driver)
■ my_drv3.drv (database driver)
■ my_drv2.drv (generate driver)
Add a c, d, or g at the end of the .drv extension: c is for copy driver, d is for
database driver, and g is for generate driver. Specify the driver= command-line
argument as follows:
adpatch driver=my_drv1.drvc,my_drv3.drvd,my_drv2.drvg

AutoPatch runs my_drv1.drv first, my_drv3.drv second, and my_drv2.drv last

(because that is the order specified).

Note: In this example, AutoPatch interprets my_drv1.drvc as

being a copy driver with the name my_drv1.drv. However, if a
patch driver file with some extension other than drvc, drvd, and
drvg is specified, AutoPatch assumes that you intend it to run the
file with exactly that extension — it does not try to re-map the
extension back to drv.

Patching Your System 2-11

Appplying Patches without Password Validation

Restarting a Non-interactive AutoPatch Session

When AutoPatch is running non-interactively and it encounters an error, it exits to
the operating system and reports a failure. When this occurs, look through the log
files, diagnose the error, and fix it.
Once the error is fixed, do not restart AutoPatch by executing the original
AutoPatch command. Use the same command line options that were used initially,
but add restart=yes.

Attention: Do not omit any of the original command line

arguments, as this would change AutoPatch’s behavior and cause
unpredictable results on restart.

Here is the command line to restart the "Applying a Single Patch Driver File"
example:

UNIX:
$ adpatch defaultsfile=$APPL_TOP/admin/testdb1/def.txt logfile=123456.log \
patchtop=$APPL_TOP/patch/123456 driver=c123456.drv workers=3 \
interactive=no restart=yes

Windows:
C:\> adpatch defaultsfile=%APPL_TOP%\admin\testdb1\def.txt logfile=123456.log \
patchtop=%APPL_TOP%\patch\123456 driver=c123456.drv workers=3 \
interactive=no restart=yes

Do not specify restart=yes when starting a new non-interactive AutoPatch session.

If there is an old AutoPatch session, AutoPatch will fail, and you can decide what to
do about the old session before proceeding with the current one.

Appplying Patches without Password Validation

AutoPatch validates the passwords for each Oracle Applications schema before
performing the actions of a driver file. When applying a series of patches in a
system where the Oracle Applications schemas or their passwords will not change,
it is not necessary to validate the passwords with each AutoPatch session. To save
time, omit the password validation by using the option=novalidate command.
1. Prepare the patching process.

2-12 AD Procedures Guide

 Merging Patches

Additional Information: See Prepare for the Patching Process in

this chapter.

2. Run AutoPatch with the following command:

adpatch options=novalidate

Merging Patches
The AD Merge Patch (admrgpch) utility merges multiple AutoPatch compatible
patches into a single integrated patch. It is an executable located in AD_TOP/bin.
To merge patches:
1. Review the readme files carefully.
Some patch readme files contain special instructions for applying merged
patches. These may include manual steps.
2. Create directories.
In the patch top area, create a source directory and a destination directory.
Choose any name for these directories.
3. Unzip patches.
Copy all patches to be merged into the source directory and unzip them.
4. Run AD Merge Patch using these arguments:
■ The source directory where the patches to be merged have been unloaded
(<source directory>).
■ The destination directory where the integrated patch will be created
(<destination directory>).
■ The name of the merged patch (-merged_name).

Note: The -merged_name parameter is optional. AD Merge Patch

uses the default merged patch names of cmerged.drv,
dbmerged.drv, and gmerged.drv when the -merged_name
parameter is not used.

From the patch top area, run AD Merge Patch with the following command:
admrgpch <source directory> <destination directory> \

Patching Your System 2-13

Merging Patches

-merged_name <name>

For example, when merging three patches called 123456, 123457, and 123458
located in the source directory ".../patches/source" to the destination directory
".../patches/destination" and using "merge99" for the name of the merged
patch, use the following command:
UNIX:
$ admrgpch /d01/patches/source /d01/patches/destination \
-merged_name merge99

Windows:
C:\> admrgpch C:\patches\source C:\patches\destination \
-merged_name merge99

AD Merge Patch reads the c<patchnum>.drv, d<patchnum>.drv, and

g<patchnum>.drv for each patch in the source directory and merges them to
create a single set of driver files (for example, cmerge99.drv, dmerge99.drv, and
gmerge99.drv) in the destination directory. It also merges the set of files
contained in the individual patches under the source directory according to file
revision and copies them to the destination directory. If a file is contained in
more than one source patch, only the highest revision of the file is copied to the
destination directory.
5. Check AD Merge Patch log files.
After AD Merge Patch runs, check the admrgpch.log file for errors. The file is
located in the current working directory where AD Merge Patch was run.

Note: AD Merge Patch cannot merge patches of different releases,

different parallel modes, or different platforms. However, AD
Merge Patch can merge patches for a specific platform with a
Generic patch, a US patch with a language translation patch, or
patches with different source character sets. When merging patches,
AD Merge Patch notifies you if there are incompatible patches.

Once a merged patch is created, apply it normally in interactive mode or as a

non-standard patch in non-interactive mode.

Additional Information: See Applying Patches in this chapter.

2-14 AD Procedures Guide

 Backing Out Patches

Backing Out Patches

To reduce the necessity of having to back out a patch, always test the application of
a patch several times on a test system, particularly if the patch is a mini-pack or a
maintenance pack. Once the test application is successful, apply it on the
production system. Follow the instructions in this section if you do have to back out
a patch.
Before applying a large number of patches, a series of mini-packs, or a maintenance
pack, back up the Oracle Applications file system and database.

WARNING: There is no automated method of backing out

patches.

Failed copy driver

Follow these steps to restore the Oracle Applications system from a failed copy
driver application:
1. Determine the cause of the failure.
In many cases, the issue can be resolved and the patching process restarted at
the point of failure.
2. Determine the copy driver actions.
If there is no feasible method of resolving the issue, restore the files that the
copy driver copied to the system. Review the log files and the copy driver to
determine the files copied by the patch and the update actions performed.
3. Restore files.
If a file in the patch directory is a more recent version than the product’s current
file, AutoPatch backs up the current file into a subdirectory of the patch
directory. If <patch_dir> is the patch directory, <env_name> is the Applications
Environment name, <appl_top_name> is the APPL_TOP name, and <prod> is
the name of the product being patched, AutoPatch backs up:
<PROD>_TOP/<subdir(s)>/<old_file_name>

to

<patch_dir>/backup/<env_name>/<appl_top_name>/<prod>/<subdir(s)>/ \
<old_file_name>

Patching Your System 2-15

Backing Out Patches

Note: The Applications Environment name and the APPL_TOP

name are determined during the Rapid Install installation process.

Use these backup files to restore the files on the Oracle Applications system. If
the patch is large and copied many files, restore the entire file system with the
backup created before applying the patch.
4. Relink files.
If the copy driver includes actions to relink files, determine the files affected
and relink them using AD Administration or, for AD programs, use AD Relink.
5. Restore apps.zip.
If the patch included Java updates, perform the following, where
<copy driver name> is the name of the copy driver. For example, if the copy
driver is c123456.drv, the copy driver name is c123456.
adjava oracle.apps.ad.jri.adjcopy -masterArchive apps.zip \
-deltaArchives <copy driver name>.zip -favorLowRevisions \
-mode APPLY

6. Generate JAR files.

If Java files are included in the patch, generate JAR files using the AD
Administration utility.
7. Generate other files.
If there are forms, reports, graphics, or message files included in the patch,
generate these files using AD Administration.

Additional Information: See Generating Files in Chapter 1.

Failed database driver

If there is a failure when applying a database driver that cannot be resolved, restore
the database with a backup copy and restore the Oracle Applications file system
updated by the copy driver.

Attention: There is no general method of backing out actions

performed by a patch on the Oracle Applications database.

2-16 AD Procedures Guide

 Backing Out Patches

Failed generate driver

Oracle Applications files can be generated by a generate driver of a patch or
through one of the generation task options in AD Administration.

Additional Information: See AD Administration in the AD Utilities

Reference Guide.

If a generate driver fails, the best option is to use AD Administration to generate all
files, or just those that were updated by the patch. If AD Administration fails to
generate these files, review the log files to determine the issue. Once isolated, fix the
issue and use AD Administration to generate the files.

Patching Your System 2-17

Backing Out Patches

2-18 AD Procedures Guide

 3
Analyzing Patch Information

This chapter describes how to use the patch history database reports to analyze
patch history information. It contains the following sections:
■ Determining if a Patch was Applied
■ Determining the Actions Performed by a Driver File
■ Determining if a Translation was Applied for a Specific Patch
■ Migrating Patch History Information

Determining if a Patch was Applied

Perform the following to determine if a specific patch was applied to the Oracle
Applications system.
1. Access the Simple Patches search screen.

Additional Information: See the Simple Patches Search section in

the AD Utilities Reference Guide.

2. Enter dates in the Applied between <begin date> and <end date> fields.
For example, when trying to determine the patches that were applied during
the period beginning January 19, 2002 and ending February 19, 2002, enter these
dates in the <begin date> and <end date> fields, and click Submit.

Analyzing Patch Information 3-1

Determining if a Patch was Applied

3. Review the Patch Summary report.

The report provides summary information for all patches applied during this
time period.

Additional Information: See Patch Summary Report in the AD

Utilities Reference Guide.

3-2 AD Procedures Guide

 Determining the Actions Performed by a Driver File

Determining the Actions Performed by a Driver File

With the Patch History Database, you can determine the actions performed by a
patch and its driver files.
1. Access the Simple Patches search screen.

Additional Information: See the Simple Patches Search section in

the AD Utilities Reference Guide.

2. Enter the patch number in the Patch field, then click Submit.

3. Review the Patch Summary report.

The Patch Summary report shows all applications of the patch. Click the Details
link to access the Patch Details report.

Analyzing Patch Information 3-3

Determining the Actions Performed by a Driver File

4. Review the Patch Details report.

The Patch Details report shows information about each of the drivers included
in the patch.

3-4 AD Procedures Guide

 Determining the Actions Performed by a Driver File

Select the radio button adjacent to a driver file and click the Action Summary
button to access the Action Summary report.
5. Review the Action Summary report.
If the driver selected is a copy driver, the Patch Summary report shows the
driver actions, such as copy, libout, and link.

If the driver selected is a database driver, the Patch Summary report shows the
driver actions, such as sql and exec.

Analyzing Patch Information 3-5

Determining the Actions Performed by a Driver File

Toggling the Hide/Show link in the Details column for a database driver action,
expands the row to show additional driver action details.

Additional Information: See the Action Details section in the AD

Utilities Reference Guide.

If the driver selected is a generate driver, the Patch Summary report shows the
driver actions, such as genform and genrep.

3-6 AD Procedures Guide

 Determining if a Translation was Applied for a Specific Patch

Determining if a Translation was Applied for a Specific Patch

If the Oracle Applications system operates in more than one language, translation
patches must be applied in conjunction with the base language patch. When
AutoPatch applies a patch and a translation patch is necessary, it prompts you with
a message. If you are not sure whether a translation patch was applied, perform the
following:

1. Access the Simple Patches search screen.

Additional Information: See the Simple Patches Search section in

the AD Utilities Reference Guide.

2. Enter the patch number in the Patch field, then click Submit.

Analyzing Patch Information 3-7

Determining if a Translation was Applied for a Specific Patch

3. Review the Patch Summary report.

The Patch Summary report shows all applications of the patch. If multiple
translations were applied, there will be multiple rows. The Language column
shows the languages applied.
For example, if the American English (US), German (D), and Japanese (JA)
translations for patch 1939407 were applied, there will be three rows in the
Patch Summary report.

3-8 AD Procedures Guide

 Migrating Patch History Information

Additional Information: See Patch Summary Report in the AD

Utilities Reference Guide.

Migrating Patch History Information

Patch history information can be migrated from one Oracle Applications system to
another. To migrate patch history information, you export information from the
source database and import it into the target database, using the Oracle
Applications Generic Loader (FNDLOAD).

Additional Information: See Generic Loader in the Oracle

Applications System Administrator’s Guide.

1. Export patch history information from the source system.

FNDLOAD uses the adphst.lct file located in AD_TOP/patch/115/import for
the migration process and creates an LDT file, specified by the <LDT filename>
argument, containing the patch history information. Use the following
command:
FNDLOAD <APPS username>/<APPS password> 0 Y DOWNLOAD adphst.lct \
<LDT filename> PATCH_RUN P_APPS_SYS_NAME=<Applications Sys Name> \
P_APPL_TOP_NAME=<APPL_TOP name> [optional export args]

Analyzing Patch Information 3-9

Migrating Patch History Information

Argument Description
P_APPS_SYS_NAME Applications System name
P_APPL_TOP_NAME APPL_TOP name
P_START_DATE Start of date range
(YYYY/DD/MM HH24:MI:SS format. For
example, 2002/01/05 23:06:24)
P_END_DATE End of date range
(YYYY/DD/MM HH24:MI:SS format)
P_BUGNUM Patch number (For example, 2079967)
P_LANG Language for NLS patches (For example, F for
French)
P_MINIPACK Mini-pack level (For example, 11i.AD.F)
P_RELEASE Release (For example, 11.5.7)
P_DRIVER_TYPE Driver type, where C is the copy driver, D is the
database driver, and G is the generate driver. If
specified, it must be C, CD, CG, CDG, D, DG or G
only.

2. Copy the LDT file to the target system.

3. Import patch history information to the target system.
Use the following command:
FNDLOAD <APPS username>/<APPS password> 0 Y UPLOAD adphst.lct \
<LDT filename> - [optional import args]

Argument Description
P_REC_ON_RLSE If a release level is specified, the patch history
database records the patches as having been
applied against it, instead of the release level
stored in the source database (For example, P_
REC_ON_REC=11.5.7 would set all patches as
having been applied at 11.5.7, regardless of what
11.5 release they were applied on in the source
system).

3-10 AD Procedures Guide

 Migrating Patch History Information

Argument Description
P_IMPORT_AT The options are Y or N. Y is the default and
imports the APPL_TOP name and Applications
system name from the source system. Selecting N
allows you to change the APPL_TOP name and
Applications system name according to the target
system.
P_APPL_TOP_NM This argument is required if P_IMPORT_AT is set
to N. It allows you to change the APPL_TOP name
to match that of the target system.
P_APPS_ENV_NM This argument is required if P_IMPORT_AT is set
to N. It allows you to change the Applications
system name to match that of the target system

Analyzing Patch Information 3-11

Migrating Patch History Information

3-12 AD Procedures Guide

 4
Modifying Your System Configuration

Throughout the lifecycle of Oracle Applications, you may decide to modify the
system configuration by adding components, products, or languages. This chapter
contains information about modifying the Oracle Applications system
configuration. It contains the following sections:
■ Licensing Components
■ Converting to Multiple Organizations
■ Converting to Multiple Reporting Currencies
■ Adding a Node

Licensing Components
Rapid Install licenses products, country-specific functionalities and languages
during the initial installation of Oracle Applications. To license additional products,
country-specific functionalities, or languages after the installation, use License
Manager.

Additional Information: See License Manager in the AD Utilities

Reference Guide.

Run License Manager

To use License Manager to license components, perform the following steps:
1. Set up license agreement.
Contact your Oracle sales representative, or set up the new product,
country-specific functionality, or language license agreements online through
the Oracle Store.

Modifying Your System Configuration 4-1

Licensing Components

2. Log on as applmgr and set the Oracle Applications system environment.

Additional Information: See Setting the Environment in the AD

Utilities Reference Guide.

3. Start License Manager with the following command:

UNIX:
$ adlicmgr.sh

Windows:
C:\> adlicmgr.cmd

4. Log on to License Manager.

License Manager displays the logon screen.

Enter the APPS username, APPS password, and the value of TWO_TASK
(UNIX) or LOCAL (Windows). Click Next.
5. Select operation.
On the Select Operations screen, License Manager provides the option of
reviewing the currently licensed products or licensing additional products.
Select Update your current Licensed Products and click Next.

4-2 AD Procedures Guide

 Licensing Components

6. License products, country-specific functionalities, or languages.

Go to the License Products, License Country-specific Functionalities, or License
Languages sections in this chapter and follow the respective procedure.
7. Close License Manager.
Click Next on each subsequent screen to navigate to the Summary screen.

Modifying Your System Configuration 4-3

Licensing Components

The Summary screen lists the licensed products, country-specific functionalities,

and languages. Click Finish to close License Manager.

License Products
Products can be licensed any time after the initial installation. To license products,
perform the following steps:
1. Run License Manager.

Additional Information: See Run License Manager in this chapter.

2. License products.
After you click "Update your current Licensed Products" in the Select
Operations screen, click Next until you get to the Orderable Products screen.
This screen displays the licensable product families. Click the check box
adjacent to a product family to license that family. Product families that are
shaded are already licensed.

Individual Oracle Applications products are licensed from the Licensable

Products screen. Click the Licensable tab at the top of the Orderable Products
screen to access the Licensable Products screen.

4-4 AD Procedures Guide

 Licensing Components

The currently licensed products are checked and grayed out. Products in the list
of licensed products cannot be removed or unlicensed using License Manager.
Select products to license, then click Next.
3. Close License Manager.
Continue clicking Next until you get to the Summary screen. Click Finish.

Additional Information: See Run License Manager in this chapter.

4. Apply product patches.

Check OracleMetaLink for any product-specific patches or mini-packs that are
required for the newly licensed product. Apply these updates at this time.
5. Generate files.
Since files used by the newly licensed product may have been updated,
generate all files for the new products.
If files were generated when you applied the product patches, omit this step.

Additional Information: See Generating Files in Chapter 1.

6. Perform product-specific implementation steps.

Modifying Your System Configuration 4-5

Licensing Components

Your new products may require setup or implementation steps. See

product-specific documentation for detatils.

License Country-specific Functionalities

To license country-specific functionalities any time after the initial installation,
perform the following steps:
1. Run License Manager.

Additional Information: See Run License Manager in this chapter.

2. License Country-specific functionalities.

After you click "Update your current Licensed Products" in the Select
Operations screen, click Next until you get to the Country-specific
Functionalities screen. This screen displays the licensable country-specific
functionalities.

Check the country-specific functionality to license it. Country specific

functionalities cannot be removed from the database using License Manager.
3. Close License Manager.
Click Next until you reach the Summary screen. Click Finish

4-6 AD Procedures Guide

 Licensing Components

Additional Information: See Run License Manager in this chapter.

4. Apply patches.
Check OracleMetaLink for any product-specific patches or mini-packs that are
required for the newly licensed country-specific functionality. Apply these
updates at this time.
5. Generate files.
Since files used by the newly licensed country-specific functionalities may have
been updated, generate all files for products associated with the new
country-specific functionalities.
If files were generated when you applied patches in Step 4, omit this step.

Additional Information: See Generating Files in Chapter 1.

6. Perform implementation steps.

Additional Information: See product-specific documentation.

License Languages
Oracle Applications is supported in 30 languages. The default language is American
English. You may decide to use another language in conjunction with the languages
that were licensed and installed during the initial installation. To license languages,
perform the following steps:
1. Run License Manager.

Additional Information: See Run License Manager in this chapter.

2. Select languages to license.

After you click "Update your current Licensed Products" in the Select
Operations screen, click Next until you get to the Languages screen. This screen
displays the currently licensed languages and the base language.

Modifying Your System Configuration 4-7

Licensing Components

Click Select Languages to access the Select Languages screen.

Highlight each new language in the available languages list and click the > to
move it to the list of selected languages. Click OK when finished.
3. Set base language.

4-8 AD Procedures Guide

 Licensing Components

Change the base language on the Languages screen, if necessary. Verify that the
enabled languages are compatible with the database character set.

Additional Information: See Choosing a Character Set in the

Oracle8i National Language Support Guide.
.

4. Close License Manager.

Click Next until you reach the Summary screen. Click Finish.

Additional Information: See Run License Manager in this chapter.

5. Convert character set.

The addition of a new language may require a conversion of the character set of
the database and the file system to one that supports all licensed languages on
the system. If this is the case, contact Oracle Support Services.
6. Install translated software.
Complete all steps in the Set Up National Language Support (NLS) section of
Installing Oracle Applications.

Modifying Your System Configuration 4-9

Licensing Components

Review Licensed Products and Languages

To review product, country-specific functionality, and language licensing
information, perform the following steps:
1. Log on as applmgr and set the Oracle Applications system environment.

Additional Information: See Setting the Environment in the AD

Utilities Reference Guide.

2. Start License Manager with the following command:

UNIX:
$ adlicmgr.sh

Windows:
C:\> adlicmgr.cmd

3. Log on to License Manager.

On the initial screen, enter the APPS username, APPS password, and the value
of TWO_TASK (UNIX) or LOCAL (Windows). Click Next.
4. Select operation.
On the Select Operations screen, License Manager provides the option of
reviewing the currently licensed products or licensing additional products.
Select Review your current Licensed Products and click Next.

4-10 AD Procedures Guide

 Licensing Components

5. Review license information.

The Current License Information screen displays the list of all products,
country-specific functionalities, and languages that are licensed.

Modifying Your System Configuration 4-11

Licensing Components

You can save the current license information to a text file or print the
information. If you click Print, the contents of this screen is sent to the printer. If
you click Save, License Manager prompts for a location to save the file.

6. Click Finish in the Current License Information screen to close License Manager.

License Off-cycle Products

An off-cycle product is one that is not included in the current maintenance release.
For example the Oracle Sales Analyzer (ZSA) product was not released as part of
Oracle Applications Release 11.5.4. However, it was made available some time after
the release of 11.5.4. To incorporate an off-cycle product, use AD Splicer to register
the product with the existing Oracle Applications system and AutoPatch to install
all product-related files. Perform the following steps:
1. Download the initial product patch from OracleMetaLink.
This patch contains information about the new product, AD Splicer control files
required to register the product, and product files.
2. Review the readme file.
Unzip the patch in the patch top directory. The patch readme file contains
information on how to install the product. There may be manual steps to
perform as part of this process.
3. Apply prerequisite patches (if any).
Information about prerequisite patches can be found in the patch readme file.
4. Create tablespaces.
All Oracle Applications products should have their own tablespaces. The
standard procedure is to create one tablespace for the product tables and
another one for the product indexes.

4-12 AD Procedures Guide

 Licensing Components

The Oracle Applications product tablespace naming standard is to add a suffix

to the product abbreviation. Add D for the product data tablespace and X for
the product index tablespace. For example, the data and index tablespaces for
the ZSA product are ZSAD and ZSAX, respectively.

Additional Information: See Creating Tablespaces in the Oracle8i

Administrator’s Guide.

5. Edit the product configuration file.

There is one product configuration file for each set of related off-cycle products.
This file is called newprods.txt by default and is in the initial product patch.
This file must be edited prior to running AD Splicer. Each off-cycle product in
newprods.txt has an entry like the following:
product=zsa
base_product_top=*APPL_TOP*
oracle_schema=zsa
sizing_factor=100
main_tspace=*Product_Name*D
index_tspace=*Product_Name*X
temp_tspace=*Temporary_Tablespace*
default_tspace=*Product_Name*D

The newprods.txt must contain all the entries shown in the example and they
must be in the exact order listed. The *APPL_TOP* entry for base_product_top
points to the location defined by the APPL_TOP environment variable. Edit the
last four parameters according to the tablespace names used to create the
product tablespaces. For example,
product=zsa
base_product_top=*APPL_TOP*
oracle_schema=zsa
sizing_factor=100
main_tspace=ZSAD
index_tspace=ZSAX
temp_tspace=TEMP
default_tspace=ZSAD

Additional Information: See AD Splicer in the AD Utilities

Reference Guide.

6. Copy AD Splicer control files and product configuration file.

Modifying Your System Configuration 4-13

Licensing Components

There are two product-related AD Splicer control files, in addition to

newprods.txt, in the initial product patch. These files are <prod>prod.txt and
<prod>terr.txt, where <prod> is the product abbreviation. Copy these control
files and newprods.txt to APPL_TOP/admin.

Note: If a newprods.txt already exists from a previous AD Splice

session, rename the existing file before copying the new
newprods.txt file.

7. Register the off-cycle product.

Log on as applmgr, set the environment, and run AD Splicer:
UNIX:
$ cd $APPL_TOP/admin
$ adsplice

Windows:
C:\> cd %APPL_TOP%\admin
C:\> adsplice

Run AD Splicer for each APPL_TOP and database combination so that the AD
utilities recognize the off-cycle products as valid.
8. Create a new environment file (UNIX) or new Applications environment
subkey in the registry (Windows).

Additional Information: See AD Administration in the AD Utilities

Reference Guide.

9. Run AD Configuration (adutconf.sql) to verify that the product was spliced

properly into the database.

Additional Information: See AD Configuration in the AD Utilities

Reference Guide.

10. (UNIX): Integrate the environment file created by AD Splicer with the existing
environment file. If the existing environment file was not customized, copy the
new version on top of the existing one.

4-14 AD Procedures Guide

 Converting to Multiple Organizations

11. Log out and log back in so that the new environment file (UNIX) or
environment subkey in the registry (Windows) is used to set up the
environment.
12. Verify that <PROD>_TOP registry and environment variables are set for the
newly spliced off-cycle products.
13. Run AutoPatch to install files and database objects for the new products.
The patch readme file lists the driver files that need to be run.

Additional Information: See Applying Patches in Chapter 2.

Converting to Multiple Organizations

Converting to Multiple Organizations (Multi-Org) requires proper testing and
preparation before converting the production system. The entire conversion process
is documented in Multiple Organizations in Oracle Applications.
One step of the conversion process, Convert to Multiple Organizations Architecture,
is performed using AD Administration. This task converts a standard product
group (not Multiple Sets of Books Architecture and not already Multi-Org) into a
Multi-Org product group with one operating unit defined at the site level.
Before running this step, define an Operating Unit and set the site-level AOL profile
option "MO: Operating Unit" to use the new operating unit. This profile option tells
AD Administration what operating unit it should use when converting the existing
data. Multiple organizations can be set up, but all transaction data is converted to
the default operating unit.
Part of the conversion process updates every row in every organization-sensitive
table with the ORG_ID for the default operating unit. Therefore, the time required
to convert to Multi-Org may vary depending on whether you have a newly
installed database or an existing production database with high transaction
volumes.

Note: To avoid the possibility of data corruption, shut down all

concurrent managers and ensure all users are logged off prior to
and during this step.

Additional Information: See AD Administration in the AD Utilities

Reference Manual.

Modifying Your System Configuration 4-15

Converting to Multiple Reporting Currencies

Converting to Multiple Reporting Currencies

The Multiple Reporting Currencies (MRC) conversion process, like the Multi-Org
conversion process, requires proper testing and preparation before converting the
production system. The entire conversion process is documented in Multiple
Reporting Currencies in Oracle Applications. In general, perform the following steps:
1. Complete the preparatory steps documented in Multiple Reporting Currencies in
Oracle Applications.
2. Set up the environment and database:
■ Verify the NLS_LANG variable
■ Create rollback segments
■ Verify SYSTEM tablespace requirements
■ Add space to existing tablespaces
3. Compile and validate the APPS schema.
Use AD Administration to compile and validate the APPS schema.

Additional Information: See Compiling Invalid Database Objects

in Chapter 1. See also AD Administration in AD Utilities Reference
Guide.

4. Convert to Multiple Reporting Currencies.

Select the Convert to Multiple Reporting Currencies task option in AD
Administration.

Additional Information: See AD Administration in the AD Utilities

Reference Guide.

5. Verify the installation.

Review the AD Administration log files for errors or warnings. Then, use the
advrfmrc.sql script in AD_TOP/admin/sql to verify the successful completion
of Step 4.
6. Perform post-installation steps.
If the system includes FastFormula, create FastFormula packages in the
APPS_MRC schema.

4-16 AD Procedures Guide

 Adding a Node

Additional Information: See Appendix B of Multiple Reporting

Currencies in Oracle Applications

7. Maintain MRC schema objects.

The APPS_MRC schema is a modified copy of the APPS schema, and requires
synchronization every time the APPS schema is updated. Use the Maintain
Multiple Reporting Currencies schema menu option in AD Administration to
synchronize the MRC and APPS schemas.
8. Perform product-specific steps.
There may be additional product-specific implementation steps to fully activate
MRC.

Additional Information: See Appendix B of Multiple Reporting

Currencies in Oracle Applications

Adding a Node
Oracle Applications can operate on any number of nodes. Rapid Install can
configure single-node or multi-node systems during the installation of Oracle
Applications. There may be situations after the initial installation that necessitate
adding an additional node.
For example, an increase in the number of users accessing Oracle Applications
forms can increase the load on the existing forms server and impact performance.
Installing another forms server or web server on a separate node can help balance
load. The additional node can support other servers, for example, an additional
concurrent processing server to take advantage of parallel concurrent processing.
To install an additional node to an existing Oracle Applications system:
1. Select an existing node with the server configuration that the new target node
will resemble.
An option is to select a node with all servers installed.
2. Perform the Cloning a Single-node System to a Multi-node System process,
using the node selected above as the source node.

Additional Information: See Cloning a Single-node System to a

Multi-node System in the Cloning Oracle Applications white paper,
OracleMetaLink Doc ID: 135792.1.

Modifying Your System Configuration 4-17

Adding a Node

4-18 AD Procedures Guide

 5
Migrating Your System

This chapter describes the process of migrating an Oracle Applications system. It

contains the following sections:
■ Migrating an Oracle Applications Database
■ Migrating a Single Instance to Real Applications Clusters
■ Migrating an Oracle Applications File System
■ Cloning Oracle Applications

Migrating an Oracle Applications Database

Migration of the Oracle Applications database refers to the act of moving an exiting
database from its current state to a different one. The migration may be to a
different version of the database server, a different platform, or a different
configuration. Refer to the correct document for the type of migration you are
performing.

When migrating your database... Then...

In preparation for upgrading Oracle Refer to Upgrading Oracle Applications
Applications to Release 11i
In preparation for applying a maintenance Refer to the maintenance pack Release Notes
pack
To a different version of the Oracle server Refer to Oracle Certify
being used with Oracle Applications (http://metalink.oracle.com/metalink/plsql/
certify.welcome) and Oracle8i Server Migration
To move it to a different platform Refer to Export/Import Process for Applications
11i Databases available on OracleMetaLink

Migrating Your System 5-1

Migrating a Single Instance to Real Applications Clusters

When migrating your database... Then...

To improve scalability or performance Refer to Export/Import Process for Applications
11i Databases available on OracleMetaLink
To change the database block size Refer to Export/Import Process for Applications
11i Databases available on OracleMetaLink

Attention: Migration of individual schemas or parts of an Oracle

Applications database is not supported.

Migrating a Single Instance to Real Applications Clusters

Real Applications Clusters (RAC) is a database option that allows multiple
concurrent instances to share a single physical database. There are essentially two
cases when migrating to Real Application Clusters (RAC) with Oracle Applications:
the fresh install case, or the case whereby Oracle Applications is already deployed
using a single database instance. The steps to migrate to RAC are essentially the
same for both cases and covered in detail in the Oracle Applications System
Administrator’s Guide.

Additional Information: See Setting up and Maintaining Oracle

Applications in the Oracle Applications System Administrator’s Guide.

Migrating an Oracle Applications File System

This section lists the tasks to relocate all or part of an Oracle Applications file
system. These steps assume all product files are being moved to another node, or all
files for one or more Oracle Applications products are being moved to another file
system on the same node, or machine.
As you complete the tasks, note the following terms:

Term Definition
Source node The machine you are migrating from.
Target node The machine you are migrating to.
Source database The original database on the source node.
Target database The destination database on the target node.

5-2 AD Procedures Guide

 Migrating an Oracle Applications File System

Moving Files on the Same Node

Typically, when moving files on the same node, a distributed installation is created
by relocating all files for one or more products. To move files for one or more Oracle
Applications products on the same node:
1. Make sure all users log off Oracle Applications.
2. Shut down any processes running on the current node.
For example, when moving files on a concurrent processing server, shut down
all concurrent managers before continuing. Or, when moving files on a forms
server, shut down the forms server listeners before moving files.
3. Copy product files.
Copy the directory trees to the new file system locations. Use the appropriate
command to move an entire directory tree at once. For example:
UNIX:
$ cp -r /d02/appl/115/gl /d05/appl2/115/gl

Windows:
C:\> xcopy /s /e /i d:\appl\115\gl e:\appl2\115\gl

Do not use the move command or delete the old files until the migration is
successful.

Warning: Do not move the AD, FND, or admin directories. They

must always be located directly under the original APPL_TOP.

4. Change environment variables.

Set the <PROD>_TOP environment variables for the product files that were
moved to the new location. In the example, set the variable GL_TOP to the new
location by doing the following:
UNIX:
$ GL_TOP=/d05/appl2/115/gl/11.5.0; export GL_TOP

Windows:

Migrating Your System 5-3

Migrating an Oracle Applications File System

C:\> set GL_TOP=D:\appl2\115\gl\11.5.0

Attention: Do this only at the operating system prompt. Do not

edit environment files yet.

5. Edit topfile.txt.
The topfile.txt file in APPL_TOP/admin contains an entry for each product. The
entry consists of the product abbreviation and the product’s base product top
directory. The base product top directory is the directory under which the
product directory is located. Often the base product top directory is APPL_TOP,
but not always. For example, if GL_TOP is set to /d05/appl2/gl/11.5.0, the
base product top directory for GL is /d05/appl2.
Since the base product top directory for one or more products was changed,
edit topfile.txt to reflect this change.
■ Open topfile.txt in an editor.
■ Find the abbreviation(s) for the product(s) that were moved.
■ Change the corresponding base product top directory entry to match the
new base product top directory.
■ Save the changes and exit the editor.

Note: A careful naming strategy for database files and product

directories eliminates data administration problems. We
recommend adherence to the Optimal Flexible Architecture (OFA)
rules and recommendations published in The OFA Standard:
Oracle8i for Open Systems.

6. Recreate the main Applications environment file (UNIX) or environment

subkey in the registry (Windows).

Additional Information: See AD Administration in the AD Utilities

Reference Guide.

5-4 AD Procedures Guide

 Migrating an Oracle Applications File System

Attention: If the main Applications environment file was

previously customized, make a backup before running AD
Administration so that the customizations can be copied to the new
file.

7. Reset the environment and restart processes.

Set the environment and restart any server processes that were shut down
earlier. Log on to Oracle Applications to test the new file system arrangement.
Once everything is working properly, allow users to access the system. Then,
remove the files from the old directory to free up space.

Migrating the File System to Another Platform

If you are moving the product files to another node that is running a different
operating system than the source node, complete the following tasks to migrate the
file system.
1. Obtain Oracle Applications software for the target node.
Obtain the software for Oracle Applications and all components in the
underlying Oracle Applications technology stack. Use the same release of
Oracle Applications software that is on the source node. For example, if Oracle
Applications Release 11.5.7 is on the source node, obtain Release 11.5.7 for the
target node. However, if the base release was 11.5.5 and maintenance pack
11.5.7 was applied, do not use Oracle Applications Release 11.5.7. Use Oracle
Applications Release 11.5.5 and apply maintenance pack 11.5.7, as well as any
technology stack updates applied to the source node, to the target node.

Attention: Ensure that the target node is running the versions of

the Oracle technology stack certified for that release of Oracle
Applications. If Rapid Install was used to install all components
and no individual components have been upgraded, then the
system is pre-certified.

2. Complete preparation steps for the target node.

The preparation steps for this process are identical to the preparation steps
required for Rapid Install. If the target node is set up to use Oracle Applications,
most of these steps will have already been completed.

Migrating Your System 5-5

Migrating an Oracle Applications File System

Additional Information: See Getting Started in Installing Oracle

Applications.

3. Install Oracle Applications product files.

Use Rapid Install to install the necessary files on the target node.

4. Migrate the database.

If the database is to be moved, perform the steps to migrate the database. If the
database will remain on the source node, point to the source database by setting
the TWO_TASK (UNIX) or LOCAL (Windows) variable.

Additional Information: See Migrating an Oracle Applications

Database in this chapter.

5. Perform post-install steps.

The post-installation steps for this process are identical to the post-installation
steps required for Rapid Install.

Additional Information: See Finishing Your Installation in

Installing Oracle Applications.

6. Apply patches.
If patches were applied to the source Oracle Applications file system that is
being replaced, apply the same patches and other platform-specific patches to
the new file system.
7. Reapply customizations.
If there are customizations, reapply, recompile, and regenerate them.
8. Verify Oracle Applications products on the target node.
Verify that the migration is successful by using Oracle Applications with the
files on the target node. When you are satisfied, remove the product files from
the source node.

Migrating the Entire Oracle Applications File System

When moving all Oracle Applications product files, we recommend using the
cloning process to recreate the entire Oracle Applications system in the new
location.

5-6 AD Procedures Guide

 Cloning Oracle Applications

Additional Information: See the Cloning Oracle Applications white

paper, OracleMetaLink Doc ID: 135792.1.

Cloning Oracle Applications

Cloning is the act of creating an identical copy of an already existing Oracle
Applications system. The new system, including component versions, operating
system versions, and platform type must initially be identical to the existing system.
Clone an Oracle Applications system:
■ To create a test system from a recent copy of the production system to use for
testing updates.
■ To periodically refresh a test system from a production system in order to keep
the test system current.
■ To move an existing system to a different machine.
Simply copying all of the Oracle Applications components will not provide a
working Oracle Applications system. There are numerous configuration files in the
system and configuration information in the database that must be modified based
on the system configuration.
The process of cloning Oracle Applications is documented in the Cloning Oracle
Applications white paper, OracleMetaLink Doc ID: 135792.1.

Migrating Your System 5-7

Cloning Oracle Applications

5-8 AD Procedures Guide

 6
Troubleshooting

This chapter contains information about troubleshooting issues that may arise when
using the AD utilities. It contains the following sections:
■ Reviewing Worker Status
■ Determining Worker Errors
■ Handling a Failed Job
■ Interrupting a Hanging Worker Process
■ Restarting a Failed or Terminated Worker
■ Restarting a Terminated Child Process
■ Restarting After a Machine Crash
■ Shutting Down the Manager
■ Reactivating the Manager

Reviewing Worker Status

AutoPatch, AutoUpgrade, and AD Administration utilize multiple worker
processes to perform jobs in parallel. There may be situations when an error occurs
and causes a worker to stop processing. AD Controller can determine the status of
workers, shut down a worker, and restart failed tasks. To review worker status,
perform these steps:
1. Log on as applmgr and set the environment.

Additional Information: See Setting the Environment in the AD

Utilities Reference Guide.

Troubleshooting 6-1
Determining Worker Errors

2. Start AD Controller.
adctrl

Additional Information: See AD Controller in the AD Utilities

Reference Guide.

3. Show worker status.

Select Option 1 from the AD Controller main menu. If any worker status shows
Failed on the the worker status screen, the issue may need to be resolved before
the AD utility can continue processing.
The following table explains the entries that may appear in the Status column.
Usually, a Failed status indicates a problem that needs to be corrected.

Status Meaning
Assigned The manager assigned a job to the worker, and the worker has not
started.
Completed The worker completed the job, and the manager has not yet assigned
it a new job.
Failed The worker encountered a problem.
Fixed, Restart You fixed the problem, and the worker should retry whatever failed.
Restarted The worker is retrying a job or has successfully restarted a job (Note
that the status does not change to Running).
Running The worker is running a job.
Wait The worker is idle.

Determining Worker Errors

When a worker fails its job, you do not have to wait until the other workers and the
manager stop. Use the worker log files to determine the problem, then, after you fix
the problem, you can restart the worker while the manager is running.

Copying the Worker Log File

Follow these steps to create a worker file for review.
1. Verify environment.

6-2 AD Procedures Guide

 Determining Worker Errors

Log in as applmgr from another terminal or terminal window and set the
environment.

Additional Information: See Setting the Environment in the AD

Utilities Reference Guide.

2. Copy the worker log file.

If the worker log file is not too large, copy the entire file to a different file name
to prevent errors that may occur if the worker tries to write to its log file while
you are reviewing it. For example, to copy and rename the entire adwork02.log
file to edit02.log, type:
UNIX:
$ cp adwork02.log edit02.log

Windows:
C:\> copy adwork02.log edit02.log

For large files on UNIX platforms, use the tail command to specify the number
of lines at the end of a large file that you want to copy to a new file. For
example, to write the last 100 lines of the adwork02.log file to short02.log, type:
$ tail -100 adwork02.log > short02.log

Fixing the Problem

Follow these steps to find and fix the problem reported by the failed worker.
1. Review the copied log file to find out why the worker failed.
The following is an example of a worker failure message:
AD Worker error:
The following ORACLE error:

ORA-01630: max # extents (50) reached in temp segment in tablespace TSTEMP

occurred while executing the SQL statement:

CREATE INDEX AP.AP_INVOICES_N11 ON AP.AP_INVOICES_ALL (PROJECT_ID, TASK_ID)

NOLOGGING STORAGE (INITIAL 4K NEXT 512K MINEXTENTS 1 MAXEXTENTS 50
PCTINCREASE 0 FREELISTS 4) PCTFREE 10 MAXTRANS 255 TABLESPACE APX

AD Worker error:
Unable to compare or correct tables or indexes or keys because of the error

Troubleshooting 6-3
Handling a Failed Job

above

In the example, the worker could not create the index AP_INVOICES_N11
because it reached the maximum number of extents in the temporary
tablespace. To fix the problem, increase the size of the next extent or the
maximum number of extents in the temporary tablespace.
2. Restart the failed job.
Run AD Controller. Choose to review the worker status, and then restart the
job.

Additional Information: See Restarting a Failed or Terminated

Worker in this chapter.

Handling a Failed Job

A worker usually runs continuously in the background and when it fails to
complete the job it was assigned, it reports a status of Failed. When the manager
displays an error message, confirm the failed status of a worker by using AD
Controller to review worker status. Then perform the following steps to correct the
problem and restart the failed worker:
1. Determine the failed file.
The Worker and Filename columns in the AD Controller worker status screen
show the numbers of the workers that failed and list the name of the files that
failed to run.
2. Review the worker log file.
Each worker logs the status of tasks assigned to it in adworkXX.log, where XX
is the worker number. For example, adwork01.log for worker 1 and
adwork02.log for worker 2. Review adworkXX.log for the failed worker to
determine the source of the error.
3. Resolve the error.
Resolve the error using the information provided in the log files. Contact Oracle
Support Services if you do not understand how to resolve the issue.
4. Restart the failed job.
Choose Option 2 from the AD Controller main menu to tell the worker to restart
a failed job.
5. Verify worker status.

6-4 AD Procedures Guide

 Interrupting a Hanging Worker Process

Choose Option 1 again. The Status column for the worker that failed should
now say Restarted or Fixed, Restart.

Note: When the manager becomes idle (that is, all workers are in
either Failed or Wait status), it automatically restarts the failed
workers one time. If the workers fail again on the same jobs,
determine the cause of the error and fix them before manually
restarting the workers.

Interrupting a Hanging Worker Process

When running the AD utilities, there may be situations when a worker process
appears to hang, or stop processing. If a worker process is hanging, it may be
necessary to interrupt it.
1. Determine what the worker process is doing.
Use the AD Controller worker status screen to determine the file being
processed and check the worker log file to see what it is doing:
■ Verify whether the process is consuming CPU.
■ Read the script to see what it is doing.
■ Check for correct indexes on the tables (if the problem appears to be
performance-related).
2. Get the worker’s process ID.
If the job is identified as "hanging", determine the worker’s process ID.
UNIX:
$ ps -a | grep adworker

Windows:
Invoke the Task Manager (Ctrl-Alt-Delete) to view processes.
3. Determine what processes the worker has started, if any.
Some worker processes spawn other processes called child processes. A worker
can spawn the following types of child processes:
■ sqlplus (SQL*Plus)
■ addmimp (DataMerge)

Troubleshooting 6-5
Restarting a Failed or Terminated Worker

■ imp (the Oracle Import Utility)

■ programs in each product’s bin directory
If there are child processes, get their process IDs.
4. Stop the hanging process.
5. Make necessary changes.
Determine the cause of the hanging process and make changes to resolve the
issue. Contact Oracle Support Services if you do not understand how to resolve
the issue.
6. Restart the job or the worker.
Use AD Controller to restart the failed job or the terminated worker.

Restarting a Failed or Terminated Worker

If a worker has terminated, or if you stop a hanging worker process, manually
restart the worker using these steps:
1. Start AD Controller.
2. Review worker status.
3. Restart the worker.
If the worker shows Running or Restarted status, but the process is not really
running, select the following options in AD Controller:
■ Option 4: Tell manager that a worker has failed its job. When prompted,
enter the number of the hanging worker.
■ Option 6: Tell manager to start a worker that has shut down. When
prompted, enter the number of the worker that failed.

Note: Restarting workers whose status is something other than

Failed will create duplicate worker processes with the same worker
ID and may cause incorrect results.

6-6 AD Procedures Guide

 Shutting Down the Manager

Restarting a Terminated Child Process

Some worker processes spawn other processes called child processes. If you stop a
child process that is hanging, the worker that spawned the process shows Failed as
the status. To fix the problem and manually restart the job:
1. Start AD Controller.
2. Review worker status.
3. Restart the failed job.
In AD Controller, select Option 2: Tell worker to restart a failed job. When
prompted, enter the number of the worker that failed.

Restarting After a Machine Crash

The manager does not automatically detect a machine crash. If the machine crashes,
perform the following steps before restarting the AD utility that was running before
the crash:
1. Start AD Controller.
2. Select the following options:
■ Option 4: Tell manager that a worker has failed its job (specify all workers)
■ Option 2: Tell worker to restart a failed job (specify all workers)
3. Restart the AD utility.

Shutting Down the Manager

Perform the following steps if AutoPatch, AutoUpgrade, or AD Administration
must be stopped before shutting down the database or the machine.
1. Select AD Controller Option 3 and enter all for the worker number. Each worker
stops once it completes or fails its current job.
2. Verify that no worker processes are running. The following command is an
example — note that the command arguments may vary on different platforms.
UNIX:
$ ps -a | grep adworker

Windows:

Troubleshooting 6-7
Reactivating the Manager

Invoke the Task Manager (Ctrl-Alt-Delete) to view processes.

3. When all workers have shut down, the AD utility exits.

Reactivating the Manager

A restarted worker resumes the failed job immediately as long as the manager is
active. The other workers change to a Waiting status if they cannot run any jobs
because of dependencies on the failed job, or because there are no jobs left in the
phase. When no workers are able to run, the manager becomes idle. Messages like
the following will appear on the screen when the manager becomes idle:
FAILED: file aftwf01.sql on worker 3 for product fnd username APPLSYS.

ATTENTION: All workers either have failed or are waiting:

Restarting all failed workers... (restart # 1)

When the manager becomes idle, it automatically attempts to restart the failed
workers. If the workers fail again on the same jobs, a message like the following will
appear:
ATTENTION: All workers either have failed or are waiting:

FAILED: file cedropcb.sql on worker 1.

FAILED: file adgrnctx.sql on worker 2.
FAILED: file aftwf01.sql on worker 3.

ATTENTION: Please fix the above failed worker(s) so the manager can continue.

In this situation, perform the following for each failed worker:

1. Determine the cause of the error.
In AD Controller, choose Option 1 to view the status. The Worker and Filename
columns on the worker status screen show the number of the workers that
failed and list the name of the files that failed to run. Review the worker log file
for the failed worker to determine the source of the error.
2. Resolve the error.
Use the information provided in the log files. Contact Oracle Support Services if
you do not understand how to resolve the issue.
3. Restart the failed job.

6-8 AD Procedures Guide

 Reactivating the Manager

Choose Option 2 on the AD Controller menu to tell the worker to restart a failed
job. The AD utility automatically reactivates, then restarts the worker processes.

Troubleshooting 6-9
Reactivating the Manager

6-10 AD Procedures Guide

 Index
A adphst.lct, 3-9
adrepctl.cmd, 1-9
Action Summary report, 3-5 adrepctl.sh, 1-9
AD Administration, 1-2, 1-5
adsplice
AD Configuration, 4-14
see AD Splicer
AD Controller (adctrl), 6-1 adstpall.cmd, 1-11
AD Merge Patch, 2-13
adstpall.sh, 1-11
AD Splicer (adsplice), 4-14
adstrtal.cmd, 1-11
control files, 4-13 adstrtal.sh, 1-11
adadmin
adutconf.sql
see AD Administration
see AD Configuration
adalnctl.cmd, 1-9 advrfapp.sql, 1-2
adalnctl.sh, 1-9 ADXCKPIN.lst, 1-4
adapcctl.cmd, 1-10
ADXGNPIN.sql, 1-4, 2-7
adapcctl.sh, 1-10 ADXGNPNS.sql, 1-4, 2-7
adcmctl.cmd, 1-10 ADXSPPIN.sql, 1-4
adcmctl.sh, 1-10
ADXSPPNS.sql, 1-4
adctrl APPL_TOP name, 2-5
see AD Controller Applications Environment name, 2-5
addbctl.cmd, 1-12
APPS schema
addbctl.sh, 1-12 compiling, 1-3
addlnctl.cmd, 1-11 validating, 1-2
addlnctl.sh, 1-11
APPS_MRC schema, 4-16
adfmcctl.cmd, 1-8 maintaining, 4-17
adfmcctl.sh, 1-8 apps.zip, 2-4
adfmsctl.cmd, 1-8
restoring, 2-16
adfmsctl.sh, 1-8 AutoPatch
adfrmctl.cmd, 1-8 backup files, 2-7
adfrmctl.sh, 1-8
compressing or deleting, 1-7
adlicmgr creating a defaults file, 2-9
see License Manager running, 2-4
admrgpch
in non-interactive mode, 2-9
see AD Merge Patch with novalidate, 2-12
adovars.cmd, 2-4

Index-1
B F
backup files family consolidated upgrade patch, 2-2
AutoPatch, 2-7 family pack, 2-2
file system
migrating, 5-2
C migrating the entire Oracle Applications file
child process system, 5-6
of worker, 6-6 migrating to another platform, 5-5
restarting, 6-5 moving on the same node, 5-3
cloning source database, 5-2
Oracle Applications, 5-7 source node, 5-2
white paper, 5-7 target database, 5-2
cmerged.drv, 2-13 target node, 5-2
concurrent managers FND_HISTOGRAM_COLS table, 1-2
starting and stopping, 1-9 FND_PRODUCT_INSTALLATIONS, 1-2
control files FNDLOAD (Oracle Applications Generic
AD Splicer, 4-13 Loader), 3-9
copy driver, 2-5 form files
cost-based optimization (CBO), 1-1 generating, 1-5
country-specific functionalities Forms Metric client
licensing, 4-6 starting and stopping, 1-8
reviewing licensed, 4-10 Forms Metrics server
starting and stopping, 1-8
D Forms server listener
starting and stopping, 1-8
database
analyzing, 1-1
migrating, 5-1 G
database driver, 2-6 generate driver, 2-6
database objects generating files, 1-5
pinning, 1-3 gmerged.drv, 2-13
dbmerged.drv, 2-13 gnumake, 2-4
defaults file, 2-9 grants and synonyms
creating, 2-9 recreating, 1-3
disk space graphic files
recovering, 1-6 generating, 1-5
docs.oracle.com, x
documentation accessibility, ix
documentation library
H
contents, x HTTP server
driver file starting and stopping, 1-10
determining if applied, 3-3
I
Invoker Rights

Index-2
 processing, 2-6 converting to, 4-16

J N
job Net8 listener
handling a failed, 6-4 starting and stopping, 1-11
newprods.txt, 4-13
NLS_LANG, 4-16
L
node
languages adding, 4-17
licensing, 4-7 non-interactive mode
reviewing licensed, 4-10 applying
License Manager (adlicmgr), 4-2 non-standard patch, 2-10
Country-specific Functionalities screen, 4-6 single patch driver, 2-9
Languages screen, 4-7 standard patch, 2-10
base language, 4-7 restarting, 2-12
Licensable Products screen, 4-4 running
licensing AutoPatch in, 2-9
country-specific functionalities, 4-6
languages, 4-7
products, 4-4 O
Orderable Products screen, 4-4 obsolete files
running, 4-1 deleting, 1-6
Select Languages screen, 4-8 off-cycle products
Select Operations screen, 4-2 creating tablespaces for, 4-12
Summary screen, 4-3 licensing, 4-12
loadjava.zip, 2-4 newprods.txt, 4-13
log files prod.txt, 4-14
compressing or deleting, 1-6 product configuration file, 4-13
registering, 4-14
terr.txt, 4-14
M
online education
maintenance pack, 2-3 about, xi
manager operating unit
restarting, 6-8 Multi-Org, 4-15
shutting down, 6-7 Oracle Learning Network
message files about, xi
generating, 1-5 Oracle Support Services
MetaLink contacting, xii
see OracleMetaLink Oracle8i server
mini-pack, 2-2 starting and stopping, 1-12
MKS toolkit, 2-4 OracleMetaLink
Multiple Organizations (Multi-Org) using, xii
converting to, 4-15 oraclestore.oracle.com, x
Multiple Reporting Currencies (MRC) ORG_ID, 4-15

Index-3
output files licensing, 4-4
compressing or deleting, 1-6 reviewing licensed, 4-10

P R
patch history database, 3-1 Real Applications Clusters (RAC), 5-2
Patch Details report, 3-4 report files
Patch Summary report, 3-2, 3-3, 3-8 generating, 1-5
patch history information Report Review Agent
migrating, 3-9 starting and stopping, 1-9
patch subdirectory, 2-7 Reports server
patch types starting and stopping, 1-9
bug fix, 2-1 rule-based optimization (RBO), 1-1
diagnostic, 2-2
interoperability, 2-2
S
new feature, 2-2
translation, 2-2 schema statistics
upgrade, 2-2 gathering, 1-2
patches source database, 5-2
applying, 2-3 source node, 5-2
in a multi-node system, 2-8 synonyms
without password validation, 2-12 recreating, 1-3
backing out, 2-15 System Global Area (SGA), 1-3
copy driver, 2-5
database driver, 2-6 T
determining
if applied, 3-1 tablespaces
if translation was applied, 3-7 creating
family consolidated upgrade patch, 2-2 for off-cycle products, 4-12
family pack, 2-2 target database, 5-2
generate driver, 2-6 target node, 5-2
high-priority, 2-2 topfile.txt, 5-4
maintenance pack, 2-3 training
merged about, xi
destination directory, 2-13 translations
source directory, 2-13 installing, 4-9
merging, 2-13
mini-pack, 2-2 U
readme files, 2-3
updates
standalone, 2-2
patching process see patches
upgrade files
preparing, 2-3
compressing or deleting, 1-6
product JAR files
generating, 1-5
products

Index-4
W
worker
child processes, 6-5
determining errors, 6-2
determining failure, 6-8
interrupting process of, 6-5
log file, 6-2
restarting, 6-6
restarting after a machine crash, 6-7
reviewing status of, 6-1
showing status of, 6-2

Index-5
Index-6