Oracle Corporation

Maintenance Wizard
User Guide
Release 2

Creation Date: March 1, 2008

Last Updated: Monday, August 25, 2008
Version: 2.12
Contents

Preface.......................................................................................................................................1

Maintenance Wizard Overview.............................................................................................2

Before You Begin......................................................................................................................6

Set Up Tasks for Maintenance Wizard..................................................................................7

Customizing Maintenance Wizard......................................................................................21

Running Steps in Maintenance Wizard..............................................................................28

About Utilities.........................................................................................................................35

About Reporting.....................................................................................................................65

Running Live Patch and Live Update.................................................................................67

Administering Maintenance Wizard...................................................................................70

Appendix A: Maintenance Wizard Common Tools..........................................................71

Appendix B: Product Specific Information for Maintenance Wizard............................85

Appendix C: Examples for Using the OS Command and SQL Query Utility...............95

Page ii
Preface
This document describes how to use Maintenance Wizard, version 2. Maintenance
Wizard includes the following features:

• Includes multiple products, each of which represents a different upgrade

path (source and destination versions).

• Includes many post-upgrade bug fixes. The R12 post upgrade patch list now
includes the contents of the Recommended Patch List (RPL), which starts the
instance out on the latest code.

• Enables you to maintain multiple tiers across different platforms including

HP Tru64 UNIX, HP-UX PA-RISC, IBM AIX based Systems, Linux x86, and
Solaris Operating System (SPARC).

• Enables you to use secured remote access (SSH) or remote shell (RSH)
communications between nodes.

• Enables you to view logs for each step performed, as well as live progress
reports, historical data, and timing reports.

• Enables you to customize projects by adding categories, product families,

tasks, and steps.

• Enables you to use OracleMetaLink to download live updates, required

upgrade patches, and any other required patches.

• Provides Web-based access to run UNIX commands and to run SQL Query
commands to check and view the Oracle E-Business Suite database settings.

Note: The screenshots displayed in this document are for illustrative purposes only.

Page 1
Maintenance Wizard Overview

Features of the Maintenance Wizard

Maintenance Wizard:

• Presents a consolidated, personalized set of instructions in a step-by-step

format

• Enables validation of important activities to prevent downstream issues

• Maintains log and status information for all tasks

• Enables Project Administrators to assign different groups of upgrade tasks to

different users

• Downloads, merges, and installs many required patches automatically

• Provides access for Web-based operating system (OS) commands to check

the upgrade processes, logs, and OS status during patch upgrades.

• Provides project management utilities to record the time taken for each task
and its completion status

• Enables maintenance of multiple customer systems

• Enables maintenance of multiple projects such as Development Maintenance,

Production Upgrade, and Test Upgrade.

• Provides different user types, each with its own responsibilities and
permissions.

• Enables the creation of customized steps to accommodate specific project

requirements.

• Documents and displays additional information linked to each step via a

user notepad.

• Provides setup substeps that can be executed to determine whether a step is

ready to be run, or may be irrelevant for the current upgrade.

• Provides validate substeps that can be executed to determine whether a step

executed successfully before continuing with the upgrade.

• Executes each step either manually or automatically.

• Provides status tracking of the setup, execute, and validate steps.

Page 2
Architecture Components

Maintenance Wizard requires the following:

• A system running a UNIX or Linux operating system with Oracle Database

10g and Oracle iAS 10g installed

• Remote or Secure Shell to be configured (For information about how to set

up a remote or secure shell, see Installing Maintenance Wizard: A Step-by-Step
Guide (OracleMetaLink Note 329476.1)

• Internet Explorer 6 or later for all end users

About Maintenance Wizard Products

Maintenance Wizard uses one of following products to assist you in your upgrade
procedure:

• Release Update Pack Assistant 12

Use this product to upgrade Oracle E-Business Suite customers who are
currently using a 12.0.x version to a later 12.0.x version. It contains all of the
steps from the 12.0.x Release Update Pack readme file. The possible upgrade
path is as follows:

o 12.0.0 or later --> 12.0.4

• Upgrade Assistant for Release 12

Use this product to upgrade Oracle E-Business Suite customers to the Release
12 version of the software. It contains all of the steps from the Oracle
Applications Upgrade Guide: Release 11i to Release 12.0.4 manual as well as the
release notes. The possible upgrade path is as follows:

o 11.5.8 or later --> 12.0.4

• Maintenance Pack Assistant for 11.5.10

Use this product to upgrade Oracle E-Business Suite customers who are
currently using the 11i version to the latest available 11i version. It contains
all of the steps from the 11.5.10.2 Maintenance Pack readme file. The possible
upgrade path is as follows:

o 11.5.3 or later --> 11.5.10.2

• Upgrade Assistant for Release 11.5.10

Use this product to upgrade Oracle Applications customers who are

currently using either the 10.7 or 11 version to the latest available 11i version.
It contains all of the steps from the Oracle Applications Upgrading Oracle
Applications Release 11i (11.5.10.2) manual as well as the release notes. The
possible upgrade paths are as follows:

Page 3
 o 10.7 SmartClient --> 11.5.10.2

o 10.7 Character --> 11.5.10.2

o 10.7 NCA --> 11.5.10.2

o 11.0.3 --> 11.5.10.2

• Applications Database Upgrade Assistant 10g

Use this product to upgrade Oracle E-Business Suite customers to Oracle

Database 10g. It contains all of the steps from the Oracle 10gR2 Database
Preparation Guidelines for an Oracle E-Business Suite Release 12 Upgrade note
and the Oracle Applications Release 11i with Oracle Database 10g Release 2
(10.2.0) note. The possible upgrade paths are as follows:

o 8i -> 10.2.0.3

o 9i -> 10.2.0.3

About Maintenance Wizard Users

Maintenance Wizard has three types of users:

• System Administrators

System Administrators are responsible for maintaining users, customers, and

projects. In addition, the System Administrator performs Live Patches to
ensure that Maintenance Wizard is updated with the latest code.
Maintenance Wizard provides one default sysadmin user. You can define
additional System Administrators.

• Project Administrators

Project Administrators configure projects, create user accounts, and assign

tasks to the Upgrade Engineers. Each project can have one or more Project
Administrators.

Note: It is not necessary to create a Project Administrator because a System

Administrator can perform all project administration tasks.

• Upgrade Engineers

Upgrade Engineers complete the actions that are a part of the upgrade. An
individual engineer might be responsible for performing all the steps of the
upgrade or just some selected steps. Usually, each project has multiple
Upgrade Engineers.

Page 4
About Categories, Product Families, Tasks, and Steps

All maintenance procedures are organized into a hierarchy of categories, product

families, tasks, steps, and substeps:

• Categories

Categories represent major groupings of tasks and steps that must be

completed during the project. These categories often correspond to chapters
in the source documentation.

• Product Families

Product Families are broad groupings of tasks and steps related to a

particular category of the project. Typically, Product Families relate to
groups of related products or aspects of the project such as Database
Upgrade steps.

• Tasks

Tasks are specific groupings of related activities, often associated to a specific

Applications module.

• Steps

Steps are the actions that must be completed during the project. Each step
includes one or more of the following substeps:

1. Setup

2. Execute (always present)

3. Validate

Every step must include an Execute substep. Setup and Validate substeps are
not required but can be used to prepare the environment (Setup) and verify
the results (Validate) for the Execute substep.

Page 5
Before You Begin
Read this section carefully; it contains important information about Maintenance
Wizard.

Note On Browser Usage: Do Not Reload or Refresh Your Browser!

When using Maintenance Wizard, do not use the Reload or Refresh feature of your
Web browser in the EOF Script Executer window. Clicking Reload or Refresh causes
Maintenance Wizard to execute the current step again. If you click Reload or Refresh
a number of times, then you will have dozens of processes running, with each
process trying to accomplish the same task. This is a common mistake when running
a long-running step!

To refresh a long-running step:

1. Close the Script Executer window by clicking X in the upper right corner.

2. Right-click the Step Action Run window and select Refresh periodically
until the step has completed.

Verify That Your Browser is Configured Correctly

If you are using Internet Explorer 6.0, you must setup the browser settings as follows
before you install Maintenance Wizard:

1. Install Microsoft Internet Explorer 6.0 or later on a client machine.

2. From the Microsoft Internet Explorer menu, select Tools, then Internet
Options.

3. In the Temporary Internet Files area, click on Settings.

The Settings window appears.

4. Select Every visit to the page.

5. Click OK twice.

If you are using Internet Explorer 7, there are additional options to set:

1. From the Microsoft Internet Explorer menu, select Tools, Internet Options,
then Security.

2. Click on Local Intranet.

3. Click on Custom Level.

4. Scroll down until you get to Scripting options

5. Locate the option “Allow status bar updates via script”

6. Select the radio button next to Enable

Page 6
Set Up Tasks for Maintenance Wizard
Before running Maintenance Wizard, you must perform some set up tasks, such as
associating customers with projects, and assigning responsibilities to users.
Maintenance Wizard comes with one default System Administrator user (sysadmin).
When you create a new project, you base it on Maintenance Wizard products.

Step 1: Logging In

Figure 1 displays the Maintenance Wizard Login page. Maintenance Wizard is

delivered with one default user account with System Administrator responsibility.

Note: Click additional setup to view the required browser settings

Figure 1 Login Page

To log in to Maintenance Wizard as System Administrator, complete the following:

1. In the User ID field, enter sysadmin.

2. In the Password field, enter sysadmin.

Note: Change this password before giving other users access to Maintenance
Wizard.

3. Click Login.
The Customer Maintenance page appears, similar to Figure 2.

Page 7
Step 2: Creating New Customers

When you log in to Maintenance Wizard as sysadmin, Maintenance Wizard displays

the Customer page from the Configuration tab. The Customer list is empty until you
add a customer. In Figure 2, some customers are added already.

Figure 2 Customer Page

To add a customer, complete the following:

1. Log in to Maintenance Wizard as sysadmin.

2. Click Configuration, then click the Customer subtab.

Maintenance Wizard displays the Customer page, similar to Figure 2.

3. In the Add Customer table, in the Customer Name field, enter the name of
the new customer.

4. Click Add.
The customer is added to the Customer list.

To change the status of an existing customer, complete the following:

1. From the Modify Customer table, select one of the following:

• Open Access – Enables full access to the customer

• Access Locked – Prevents all access to the customer

2. Click Modify.

Page 8
Step 3: Creating a Project

To perform the upgrade, you must create a project. A project is used for a single
iteration of the upgrade process. As you progress through the various test upgrades,
you will create new projects each time.

Maintenance Wizard provides a Master project. The Master project populates each
new project with data. You can also copy data from a previous project if you have
customized it. To view existing projects, click Configuration, then click the Projects
subtab. The Project Maintenance page appears similar to Figure 3.

Figure 3 Projects Page

To create a new project, complete the following:

1. Click Configuration, then click the Projects subtab.

The Project Maintenance page appears similar to Figure 3.

2. In the Add Project table, from the Customer Name list, select the customer
for whom you are creating the project.

3. In the Project Name field, assign the project a brief but concise name. It
should be unique with each Customer Name.

4. From the Product list, select the product that corresponds to the type of
upgrade you are performing.
Note: It is very important that you choose the correct product because you
cannot change it later. For more information about these products, see About
Maintenance Wizard Products.

Page 9
 5. Click More Details. Depending on the selected product, the Add Project
table displays additional options.

6. From the Source Version list, select the version from which you are
upgrading.

7. From the Destination Version list, select the version to which you are
upgrading.

8. In the Remote EOF_HOME field, enter the name of the directory where the
EOF_HOME directory is stored on each tier. This is a directory name and not
a directory path. Maintenance Wizard creates a directory with the same
name on each remote tier.
Note: This value must be unique.

9. From the Copy Steps from list, select the existing project from which you
want to populate the new project. Select the Master project to populate the
new project with data. If you added steps to a previous project or you want
to copy notes from a previous project, then you can select that previous
project.

10. Click Add to save the new project.

Note: To delete a project, go to the Administration tab and click the Delete
button next to the appropriate project name in the Delete Project table.

Step 4: Creating New Users

To add a new user, complete the following:

1. Log in to Maintenance Wizard as a System Administrator or a Project

Administrator.

2. Click User Admin, then click the Add User subtab.

The Add User page appears, similar to Figure 4.

Page 10
Figure 4 Add a New User

3. In the User Name field, enter a user name for the new user. For example,
jsmith.

4. In the Full name field, enter the full name of the user. For example, John
Smith.

5. In the Email Address field, enter an e-mail address for the user. For example,
john.smith@acme.com

6. In the Password field, enter a password for the user.

7. In the Re-enter Password field, enter the password again.

8. In the Description field, enter a description for the user. For example,
Financials System Analyst.

9. In the Phone Number field, enter a phone number for the user.

10. Click Add.

Page 11
Step 5: Assigning a Project Administrator

The first type of user required is a Project Administrator. The Project Administrator is
responsible for assigning specific tasks to Upgrade Engineers.

To assign Project Administrator privileges to a user, complete the following:

1. Log in to Maintenance Wizard as a System Administrator.

2. Click User Admin, then click the Assign Proj Admins subtab.
The Assign Proj Admin page appears, similar to Figure 5.

Figure 5 Assign a Project Administrator

3. In the Assign Project Administrator Role table, from the Customer/Project

list, select the project to which you want to assign a Project Administrator.

4. From the Select user to assign list, select the user that you require for Project
Administrator.

5. Click Assign.
A message appears stating that the user was successfully assigned.

Note: From the List Administrators for Selected Project table, select a project to
view the Project Administrators assigned to that project. Click Remove to delete
a Project Administrator from a project.

Page 12
Step 6: Registering Nodes for the Project

A Project Administrator must register nodes for the project before performing any
other tasks.

To register nodes for a project, complete the following:

1. Log in to Maintenance Wizard as a Project Administrator.

Note: If you are logged in as a System Administrator, proceed to step 2.

2. Click Roles.
The Role page appears similar to Figure 6.

Figure 6 Role Page

3. From the Project Administrator list, select the project name.

The Project Maintenance page appears similar to Figure 7.

Page 13
Figure 7 Project Maintenance Page

4. Check that the initial project setup is correct. Click Edit to make any changes.

5. Click Define Nodes.

The Define Nodes page appears similar to Figure 8.

Figure 8 Define Nodes

6. From the Node Source Type list, select a method:

• Manually specify node attributes

• Copy from existing customer/project
• Read from AutoConfig

Note: In general, you can use any combination of the three methods to define the
nodes in your project. However, some node types cannot use all three methods.
For example, some node types cannot be defined by the AutoConfig file.

Page 14
 To manually specify node attributes, complete the following:

1. From Node Source Type list, select Manually specify node attributes.
The Manually Enter Node(s) page appears, similar to Figure 9.

Figure 9 Manually Enter Node

2. In the Fully Qualified Hostname field, enter the name of the host on which
the nodes will reside. Ensure that you include the domain name of the host.

3. In the Username field, enter the operating system (OS) user name for the
host specified in step .
Note: If you have multiple OS users (for example a user that owns the
database and another user that owns the Applications), you must specify
those nodes separately.

4. From the Platform list, select the required platform.

5. From the Remote Access Type list, select whether you want to use remote
shell or secure shell for remote execution.

6. Select the type of node that you are defining. Ensure that the selected node is
owned by the OS user specified in step .
Note: To select multiple for the same host, use SHIFT+select or CTRL+select.

7. Click Save.
The Attributes page appears similar to Figure 10.

Page 15
Figure 10 Attributes Page

8. In the Attributes table, enter a value for each of the attributes. The displayed
attributes depend on the nodes that you selected in step .

9. Click Save.
The Registered Nodes table appears.

10. Click Configure to define the nodes when you have registered all the node
types using any combination of the methods as described in step on page 14.

Note: You must define data for all node types before you can continue. If the
Configure button is not available, then you have not defined all the required node
types completely.
To copy From Existing Project, complete the following:
1. From the Node Source Type list, select Copy from existing customer/project.
The Copy Node(s) page appears.

2. From the Copy Node Attributes from customer/project list, select the project
from which you want to copy the node attributes.

3. From the Node TYPE(s) list, select the type of node that you are defining.
Note: To select multiple nodes for the same host, use SHIFT+select or
CTRL+select.

4. Click Copy.
The Registered Nodes table appears

5. Click Configure to define the nodes when you have registered all the node
types using any combination of the methods as described in step on page 14

Note: You must define data for all node types before you can continue. If the
Configure button is not available, then you have not defined all the required node
types completely.

Page 16
To define the nodes automatically by reading the AutoConfig file, complete the
following:

1. From the Node Source Type list, select Read from AutoConfig.
The Administration Node Autoconfig Setup page appears.

2. In the Fully Qualified Hostname field, enter the name of the host on which
the nodes will reside. Ensure that you include the domain name of the host.

3. In the Username field, enter the operating system (OS) user name for the
host specified in step .
Note: If you have multiple OS users (for example, a user that owns the
database and another user that owns the Applications), you must specify
those nodes separately.

4. In the Autoconfig Path field, enter the full path of the AutoConfig utility.
Note: Do not use any environment variables. Ensure that you enter the full
path such as /u01/foo/applmgr/apps/apps_st/appl/admin/PROD1.xml.

5. From the Platform list, select the required platform.

6. From the Remote Access Type list, select either remote shell or secure shell

7. From the Node Type(s) list, select the type of node that you are defining.
Some node types that are not registered yet may not appear in this list
because they are cannot be configured using this method. Ensure that the
selected node is owned by the OS user specified in step .
Note: To select multiple nodes for the same host, use SHIFT+select or
CTRL+select

8. Click Next.
The nodes appear in the Registered Node(s) table. A window may appear to
indicate that Maintenance Wizard could not retrieve some values from
AutoConfig file. If this occurs, you must edit the attributes for the nodes
displayed in the window and correct the values assigned to those attributes
before proceeding.

9. Click Configure to define the nodes when you have registered all the node
types using any combination of the methods as described in step on page 14.

Note: You must define data for all node types before you can continue. If the
Configure button is not available, then you have not defined all the required
node types completely.

Page 17
Step 7: Assigning Responsibilities to Users

The Project Administrator must assign responsibilities to engineers.

To assign responsibilities, complete the following:

1. Log in to Maintenance Wizard as a Project Administrator.

Note: If you are logged in as a System Administrator, proceed to step 2.

2. Click User Admin, then click the Assign Engineers subtab.

The Responsibilities page appears.

3. From the User Name list, select the name of the required engineer.
Note: If the required engineer does not appear in the list, see Step 4: Creating
New Users.
The Responsibilities page appears similar to Figure 11.

Figure 11 Responsibilities

Page 18
 4. For each Category on the page, click the plus sign (+) to expand the list and
view the product families and tasks associated with that category.

5. Click the check box beside an entry to assign it to the selected engineer. You
can assign any combination of the Category, Product Family, or Task levels.
If you assign a higher-level entry to a user, then Maintenance Wizard
includes all entries below that level in the hierarchy.

Note: To assign all tasks to the selected engineer, click Assign All at the
bottom of the page. This option ignores any previous selections and forces a
save.

The Assign All option does not include Development Responsibility, OS

Command Access SQL Query Access, or Patching Access.

a. To enable the engineer to customize the project content, click

Development Responsibility.

b. To enable the engineer to access the OS Command Access feature,

click OS Command Access. Ensure that the option is only granted to
users with operating system access to the Applications system.

c. To enable the engineer to access the SQL Query feature for this
project, click SQL Query Access. Ensure that the option is only
granted to users with database query access to the Applications data.

d. To enable the engineer to access the Patch Monitoring feture, click

Patching Access. Ensure that the option is only granted to users with
patching access to the Applications system.

Note: Assigning the Patching Access option automatically assigns

OS Command Access and SQL Query Access to the engineer. You
cannot remove the OS Command Access or the SQL Query Access
while the Patching Access option is selected.

6. In the Save Responsibilities row, click Save.

Updating a User Profile

You can now update your own personal profile settings for the current project that
you are logged into. You may manually specify a value or reset it to the default
value. To update your profile, complete the following:

1. Log in to Maintenance Wizard as a System Administrator, Project

Administrator, or an Upgrade Engineer

2. Click User Admin, then click the Update Profile subtab.

The Update Profile page appears, similar to Figure 12.

Page 19
Figure 12 Update Profile Screen

3. Modify the desired Attribute Value field and click Save or click Reset to
restore an Attribute Value to its default setting

4. Click OK on the confirmation popup screen.

Note: Only one attribute may be updated at a time.

Page 20
Customizing Maintenance Wizard

Adding Additional Categories, Product Families, Tasks and Steps

After installing Maintenance Wizard as described in Installing the Maintenance Wizard:

A Step-by-Step Guide (OracleMetaLink Note 329476.1), determine if you need
additional categories, product families, tasks or steps to accommodate
customizations, interfaces, and other organization-specific steps. Check the current
project and investigate each customization to determine how it should be resolved.
You must have a thorough understanding of the current installation and how it
works for all products installed. Omitting information at this stage may return
unexpected results.

Note: Skip this section if you do not require additional categories, product families,
tasks or steps.

Add new categories, product families, tasks, or steps in the following order:

1. Categories

2. Product Families

3. Tasks

4. Steps

Add Categories
Note: You must have development responsibility for the current project to add
categories. For more information about granting development responsibility, see step
5 of Step 7: Assigning Responsibilities to Users.

You can insert new categories or update existing categories that you created.

Note: You cannot update or delete predefined categories that come seeded in
Maintenance Wizard.

To add a category, complete the following:

1. Log in as the Upgrade Engineer.

The Roles page appears

2. From the Engineer list, select the required project.

The Process page appears, similar to Figure 13.

Page 21
Figure 13 Process Steps

3. Click the Customize tab, then from the Select Action list, select Category.
The Category table appears similar to Figure 14.

Figure 14 Category Page

Note: You may not see all of the categories displayed in Figure 13 because
the categories depend on your configuration. The Action column is not
available for Oracle seeded categories because you cannot modify these
categories.

Page 22
 4. Scroll down to the empty row in the Category table, then enter the new
category name. The category name is limited to 20 characters.

5. In the Order By field, specify where to insert the new category.

Note: This category only appears in the drop-down list of the Process page
after you add Product Families, Tasks, and Steps.

6. Click Insert to save your changes.

Add Product Families

Note: You must have development responsibility for the current project to add
Product Families. For more information about granting development responsibility,
see step 5 of Step 7: Assigning Responsibilities to Users.

You can insert new product families or update existing product families.

Note: You cannot update or delete predefined product families that come with
Maintenance Wizard.

To add a product family, complete the following:

1. Log in as the Upgrade Engineer.

The Roles page appears.

2. From the Engineer list, select the required project.

The Process page appears, similar to Figure 13.

3. Click the Customize tab.

4. From the Select Action list, select Product Family.

5. Select the category to which the new Product Family belongs.

The Category Configuration portlet appears similar to Figure 15.
Note: You may not see all of the product families because the product
families depend on your configuration. The Action column is not available
for Oracle seeded entries because you cannot modify these entries.

Figure 15 Adding a Product Family

Page 23
 6. In the Product Family field, enter the name in the empty row.

7. In the Order By field, specify where to place the new product family.

8. Click Insert to save your changes.

Add Tasks
Note: You must have development responsibility for the current project to add tasks.
For more information about granting development responsibility, see step 5 of Step 7:
Assigning Responsibilities to Users.

To add tasks, complete the following:

1. Log in as the Upgrade Engineer.

The Roles page appears.

2. From the Engineer list, select the required project.

The Process page appears, similar to Figure 13.

3. Click the Customize tab.

4. From the Select Action list, select Task.

5. Select the category to which the new task belongs.

6. Select the product family to which the new task belongs:

The Category:Configuration table appears similar to Figure 16.
Note: You may not see all of the tasks because the tasks depend on your
configuration. The Action column is not available for Oracle seeded entries
because you cannot modify these entries.

Figure 16 Add a Task

Page 24
 7. In the empty field in the Task column, enter a name of the new task.

8. In the Order By column, enter the position as an integer where the new task
appears in the list of steps.

9. In the Documentation Link column, enter the URL for associated

documentation if it is available. This URL appears as a link on the Task name
when viewed in the Process tab.

10. Click Insert.

Add Steps
Note: You must have development responsibility for the current project to add steps.
For more information about granting development responsibility, see step 5 of Step 7:
Assigning Responsibilities to Users.

For additional information about writing scripts to use with Maintenance Wizard, see
Maintenance Wizard Scripting Language (OracleMetaLink Note: 291888.1).

To add steps, complete the following:

1. Log in as the Upgrade Engineer.

The Roles page appears.

2. From the Engineer list, select the required project.

The Process page appears, similar to Figure 13.

3. From the Select Category list, select the Configuration category.

4. Click the Customize tab.

5. From the Select Action list, select Step.

6. Select the category to which the new step belongs.

7. Select the product family to which the new step belongs.

8. Select the task to which the new step belongs.

The Category: Configuration table appears, similar to Figure 17.

Note: You may not see all of the steps because the steps depend on your
configuration. The Action column is not available for Oracle seeded entries
because you cannot modify these entries.

Page 25
Figure 17 Add a step

9. Enter values in the following fields:

Field Description

Order By Enter the position as an integer where the new task appears in the list of
steps.
Step Num Provide a number for the new step.
This number must be unique within the particular task and indicate the
sequence of the steps. For example, the first step has a value of 1 and the
third step has a value of 3; the new step to appear between these steps is
given the value of 2. If you want to insert a step between 2 existing steps,
you must renumber the current step and all subsequent steps, then insert
the new one. For example:

Renumber
Original Existing Steps Insert New Step
Step 1: Do A… Step 1: Do A… Step 1: Do A…
Step 2: Do B… Step 2: Do D…
Step 3: Do C… Step 3: Do B… Step 3: Do B…
Step 4: Do C… Step 4: Do C…

Step Condition Click the Notebook icon to specify whether the step is required, optional,
recommended, or conditionally required.
Source Click the Notebook icon to select C for custom.
Documentation
ID
Apps Short Click the Notebook icon to select the Application short name. Only
Name Applications that are installed in your Applications environment appear
in the list.
Install Status Click the Notebook icon to select the install status. The step is displayed if
you select one of the following:
I – Product is installed
S – Shared only
IS – Product is installed or shared
Note: You must specify this value by selecting the Notebook icon or by
using uppercase. If you specify the value in lowercase, Maintenance
Wizard displays an error message.
Version ·Specify the version from which you are upgrading. You must enclose the

Page 26
 Field Description

Filter:From version number in colons. For example:

:11.5.8:
Version Filter:To Specify the version to which you are upgrading. You must enclose the
version number in colons. For example:
:12:
Platform Click the Notebook icon to select the platform to which the step applies. If
Specification it is not specific to any platform, select All.
Step Enter a name to describe the new step.
Script ID This field is an internal identifier and is automatically populated by
Maintenance Wizard.
TUM's Step Key This field is an internal identifier and must remain blank.

10. Click Insert.

11. Click the Preview icon at the bottom right of the screen to view the
information contained in the Setup, Execute, and Validate script notes.
Figure 19 shows an example of this content.

Figure 19 Preview Icon Content

The new categories, product families, tasks, and steps are available within
Maintenance Wizard. Verify that each new element appears as intended.

Page 27
Running Steps in Maintenance Wizard
Note: Before you start a project, refer to the Before You Begin section of this guide.
When running steps, perform all steps in the order in which they are specified. If you
do not complete steps in the required order, the success of the project could be
compromised.

Accessing Maintenance Wizard Steps

To access the maintenance wizard steps, complete the following:

1. Log in as the Upgrade Engineer.

The Roles page appears.

2. From the Engineer list, select the required project.

The Process page appears, similar to Figure 13.

3. From the Select Category list, select a category from the list. The
Configuration category prepares your system to run Maintenance Wizard
and comes with Maintenance Wizard. The other available categories depend
on your set up and configuration.

Important Notes:

• To view the full list of categories applicable to your installation, you must
complete all of the steps in the Configuration category. When you complete
these steps, you must refresh the lower left pane of your Web browser. The
entire list of categories appears. If, after completing the configuration tasks,
you still do not see the entire expected list, please refer to the Maintenance
Wizard FAQ (OracleMetaLink Note: 407085).

• This list of categories is subject to change.

About the Maintenance Wizard Interface

The following table provides a list of the icons that enable you to scan the list of tasks
and steps for each category and product family to determine the status of each step.

Icon Icon Name Description

Green Check Mark in Circle (Complete)
Blue Box in Circle (Incomplete)
Red X in Circle (Under Execution)
Indicates that the step has been
automatically executed and the
user indicated that the step
finished successfully
Indicates that the step has never
been completed or has been
reported as a step requiring
execution again.
Indicates that the step was
executed automatically but the
user did not indicate the success or
redo of the step.
The window was closed without
clicking Success or Redo. Steps
that take a long time to run often
display this icon.

Page 28
 Icon Icon Name Description

Blue Man with Check (Manually Complete)
Red Circle with Slash (Auto Skipped)
Indicates a step that was manually
completed by the user.
Indicates that Maintenance Wizard
automatically skipped the step.
The tool determined that the user
does not have to perform this
portion of the step. Usually the
Note field contains the reason for
skipping the step.

Actions for Each Step in the Project

Each step has a minimum of one and a maximum of three required substeps. These
substeps are called Setup, Execute, and Validate. For manual steps, the text should
indicate the commands that you are required to perform. However, many actions
include scripts that automate the process.

Action Description

Setup The Setup substep runs a process that verifies the following:
(This substep is • If execution of that step is required
optional) • If the data is ready for the Execute substep to process
Specifically, it details the Oracle Applications navigation steps, additional
details, objects to be checked, and criteria for checking them.
Execute The Execute substep either runs the script provided with Maintenance
(This substep is Wizard or it displays the navigation required to perform the step manually.
mandatory) Specifically, it details the action for the actual work that is required.
Note: Every step must have an Execute substep.
Validate The Validate substep verifies that the step is complete and it is OK to
(This substep is continue with the next step. Specifically, it attempts to determine whether
optional) the Execute substep was successful and details specific objects to be checked
and the criteria for checking them.

Executing a Step Automatically or Manually

You have the option to perform any step manually as displayed in Figure 17.

• Manual: Manual step execution requires you to perform the work manually.
You must record the success or redo of the step upon completion. Enter the
hours and minutes required to complete the step, then click Manual. The
step window appears similar to Figure 20.

Page 29
Figure 20 Executing a Step Manually

• Automatic: Click Run to run a provided script automatically. You must

select the success or redo button for that step upon completion. Maintenance
Wizard records the execution time taken for the step. In addition, each
automated sub step prompts the user for an optional "additional think time"
both before and after the actual step execution. This field can be used to store
time for tasks such as research, data correction, and customization handling.
It also appears on the Management Report. If an automatic step has already
been run, the most recent log file is displayed.

Note: You can always run an automatic step manually by clicking Manual.

Page 30
Figure 21 Executing a Step Automatically

Note: If you want to include multiple sets of parameters, you can run the automated
steps multiple times. To do this, select Redo even if it runs successfully, then run the
step again with the next set of parameters. Keep selecting Redo and re-running it
with the new set of parameters until each set has been included. Mark the step a
success after you have run the last set of parameters. The log file for each execution is
saved and available through the Audit window.

Marking the Success or Redo of Each Step

Upon the completion of each substep (Setup, Execute or Validate), you must click
either Success or Redo as shown in Figure 22.

Page 31
Figure 22 Completing a Step

Depending on the choice you make, the status of the step is marked either Complete
or Not Run.

• Success: Record the step as a success when it completes as expected.

• Redo: Record the step as Not Run if it does not complete at all, or if it
completes with problems.

Sometimes a step takes longer to execute than the framework can wait; this is called
"timing out". To refresh a step, close the Script Executer window using the X in the
upper right corner, then right-click and select Refresh on the Step Action Run
window periodically until the step is complete.

Maintenance Wizard Online Help

Figure 23 shows an example of the online documentation that is available within the
tool:

Page 32
Figure 23 Online Help

Links to MetaLink Notes

Upgrade Support Note

• Links to Documentation or MetaLink Notes: Many steps contain links to

additional information in OracleMetaLink.

• User Note: The Edit User Note button and the Notepad icon beside each step
enable you to record information for each step. Use this feature to facilitate
the next test or go-live project. Add your notes in the text box and click Save
to exit. Click the link again to add more information. As each test is
performed, this becomes another part of the documentation that customizes
your project.

• Online Documentation: There are several links to product documentation

on the left of the main screen on the Process page similar to Figure 13. Click
the links to view various types of product documentation, including
OracleMetaLink notes and documents.

• Task Help: For some tasks, you can click the task name and context-sensitive
information is displayed.

Viewing Log Files

Maintenance Wizard captures log files for all substeps that have been automatically
executed. To view the most recent log file for a particular substep, click the status
icon for that step. If the step has been run, the log file is displayed in the step status
window. To view all log files for a particular substep, click the Audit icon beside that
step, and then click Notebook icon in the Log column. The Audit window appears
similar to Figure 24 and Figure 25 shows the contents of a log file.

Page 33
Figure 24 Audit Window

Figure 25 Log File Contents

Page 34
About Utilities

Maintenance Wizard Patching Tool

The Maintenance Wizard Patching Tool provides a single interface to apply, monitor,
and restart adpatch. It also facilitates the running of key SQL queries and the
viewing of all related ad log files. The key features of this tool incude the following:

• Download, apply, and verify that a patch has been applied

• Monitor adpatch and all related processes and log files
• Control key E-Business services, such as starting, stopping, and monitoring
forms, web serivces etc.
• Monitor Key patch related database tables during and after patching
• Control adpatch workers with ADCTRL to start, stop and monitor all active
workers
• Control automatic e-mail or SMS Patch Alerts to monitor patch progress
• Automatically shows errors in logs and hot-links to Metalink articles for research
• Search Metalink with one click for known issues with the current patch
• Directly link to all the E-Business related patching and administration
documentation
• Dynamic menus for each Maintenance Wizard product, such as Point release,
Upgrade, Database, etc.

Currently the patching tool is tightly integrated to Maintenance Wizard to provide

many of the existing features of the wizard, but in a consolidated portal without the
need to run multiple screens to execute or review output. The patching tool was built
to be an extension to the current utilities, such as OS and SQL, as a means to provide
direct contol and monitoring while applying a patch.

To run the tool, complete the following:

1. Login as an Engineer
2. From the Process tab click the Utilities subtab.
The Utilities page appears similar to Figure 26

Figure 26 Utilities Subtab

Page 35
 3. Click the Run Patching Tool link under Ebiz Support. The patching tool gets
loaded on the screen as shown in the Figure 27.

Figure 27 Oracle MW Patching Tool

Note: You can also launch the patching tool from the patching steps under the
Utilities subtab. On doing so, the patch number will be automatically set.

To run this patching tool from the patching step, complete the following:

1. Login as an Engineer
2. From the Process tab select the Utilities subtab.
3. Run the execute step for any of the three steps under “TASK: Patching for all
releases”
4. After you supply the required runtime parameter and after clicked the Run
button, the new Script Executer window opens
5. Click the Run Patching Tool for <patch number> button to launch the
patching tool from the patching step.

Two key values must be set properly before running any feature of this tool:

1. The patch number.

2. The active node you are executing on.

To set the patch number, complete the following:

1. Select the Applying Patches menu

2. Select the Set Active Patch submenu. This will open up a prompt for patch
number.
3. Supply the patch number and click OK.
The tool title at the top left corner of the screen will show the patch number

Page 36
 To set the Active node, complete the following:

1. Select the Options menu.

2. Select Pick Node. It will show up the list of nodes.
3. Click the node you want the rest of the patching tool features to execute its
command on.

Note: The exception to this is for the Patching Alerts feature that automatically
figures out the current active patching node (if multi-node) and returns output
based on that node’s logs for the text of the Alerts.

MW Patching Tool Menus

The following points outline the functions of the Maintenance Wizard Patching Tool
menus:

o Applying Patches - Provides a means to download, apply, and check a patch as

well as view patch readmes and log files. You can also setup Patch Alerts, which can
be delivered via e-mail or SMS.

o Patch Logs – Use this menu to view all key patching logs and configuration files,
such as adalldefaults.txt, autoconfig’s config.xml, and APPSORA.env. You can also
use the Options menu to set the tail size for viewing and to automatically refresh the
view.

o Monitoring – This menu lists key UNIX commands to monitor the OS and Database
tables related to patching.

o AD Workers – This is the place to control and monitor the adworker processes
during patching.

o Services – This menu provides a means to check that status or start/stop 11i or R12
Services defined for this project

o Options – Use this menu to change default file tail size, font size, active tier, node,
and automatic refresh settings.

o Help - Most of the help options are links to key documents and web sites
supporting MW, EBS, or researching patch issues.

Applying Patches

The features in this menu provide the option to download a patch, apply the patch, and
verify for the proper application of the patch. It provides a means to check the patch
history, current patch log, and entire list of files included within the patch top. It also
has an option to monitor the adpatch processes, workers, and database settings.

Page 37
Figure 28 Applying Patches

Main Monitor Patch

This option has three main monitor choices as shown in figure 29.

1. Adpatch
2. Workers
3. SQL Monitoring

Figure 29 Main Monitor Patch

Page 38
Adpatch Monitoring

Click the gray arrow to reveal the following different options associated with
monitoring Adpatch:

• Processes
This option lists the adpatch processes that are currently running on the
corresponding node. It includes the information for each process, including the
current system time, the elapsed time for that process, the process id, and its
CPU utilisation.
• tail <patch number>.log
This option lists out the last 30 lines of the adpatch patch log file for the patch
number.
• Restart Files
This option lists out all the restart files that are present under directory
$APPL_TOP/admin/$TWO_TASK/restart
• CPU
This option reports CPU utilization for each second. Three lines are displayed.
• Summarize
This option summarizes the Adpatch actions

Worker Monitoring

Click the gray arrow to reveal the following different options associated with
monitoring Workers:

• Processes
This option lists the worker processes that are currently running on the
corresponding node.
• Ls Adworker Log
This option lists out the log files that are present under the directory
$APPL_TOP/admin/$TWO_TASK/log.
• adwork0*.log
All the adwork0*.log options display the last 30 lines of the corresponding
worker log files.
• Summarize
This option lists the summary of all the above options, it displays the list of all
the worker processes and then shows the last 10 lines of all the worker logs.

Page 39
SQL Monitoring

Click the gray arrow to reveal the following different options associated with
monitoring SQL:
• Applied Patches
This option lists out all the patches that are applied in the corresponding node.
The patch information includes Patch name, Application Short Name, the Patch
Type, Patch Level, and Applied date.
• AD Workers
This section shows the SQL output from FND_INSTALL_PROCESSES, which
includes the control-codes and status along with what file each worker is
currently processing.
• AD Sessions R12
This option can be seen only for Upgrade to R12 product. This option lists out
the AD Session details of an R12 environment.
• AD Job Details
This option lists the AD Job Details.
• DB Settings
This option lists out the following database settings:
• NLS Parameters
• NON-DEFAULT init.ora SETTINGS
• DEFAULT init.ora
• DB Sessions
This option lists information about database sessions. This includes the
following:
 Date Report Run – tells the date the report was run.
 Current Active database sessions – lists all the database sessions that are
currently active.
 Session Counts – lists the database session counts by:
♦ Status
♦ OS User
♦ Module
• DB Locks
This option lists the type of locks applied for the database objects, their status,
the db object’s name, process id, UNIX/database username, etc.
• DB Space
This options displays
• Free space available on each database tablespace
• Size of each datafile of all the tablespaces.
• DB Invalids
This option lists the database invalid objects. This involves the following:
 Date Report Run
 Invalids Count by Type
 Invalid Packages
 Invalid Views
 Invalid Synonyms
 Invalid Triggers

Page 40
Monitor Active Patch

This option displays the log information associated with the application of a patch.
Clicking this sub-menu displays a table with two columns called File and Info. The File
column contains entries for the Current patch log, Restart Files, AD Worker logs, and
AD Table Statistics. The Info column lists the Last updated date, the size in bytes if it is
file, and the place where it is run if it’s a query.

Figure 30 Monitor Active Patch

• Current Patch Log – Displays the last 10 lines of the adpatch log
• AD_TABLES statistics – If patch application is complete, displays the date and
time the patch was applied based on AD_APPLIED_PATCHES and AD_BUGS
tables.
• Restart Files – lists the restart files under $APPL_TOP/admin/
$TWO_TASK/restart
• Worker Status – Displays the workers status.

Click the Refresh button to refresh the contents of the file you selected to display. You
can automatically refresh its content by setting Options > Automatic Refresh for the
time frame required.

Patches History
This option describes the patch history for the particular patch, which includes listing
AD Patches that are currently running, AD Worker Processes, Recent Worker logs, and
Patch Top files for the active patch.

Patch Action
The Patch Action sub-menu displays the list of actions that can be taken on patching,
which includes patch download, patch application, verifying application, restarting the
patch application, and resetting it.

The Following options are available under this sub-menu:

• Download – downloads and unzips the patch

• Apply – Applies the patch
• Verify Applied – Verifes the patch application
• Restart – Restarts the patch application

Page 41
 • Reset – Resets the patch application.
• Maintenance Mode – This has two options:
 On Enable – This turns on / enables the maintenance mode
 Off Disable – This turns off / disables the maintenance mode.

If you are upgrading to R12, then the following options also appears:

• R12 Download - downloads and unzips the patch in R12 env

• R12 Apply - Applies the patch in R12 env
• R12 Verify Applied - Verifies the patch application
• R12 Restart - Restart the patch application in R12 env
• R12 Reset - Resets the patch application in R12 node
• R12 Admsi Prereqs – This runs the Patch Application Assistant (admsi.pl)
report
• R12 Maintenance Mode – This has two options:
 On Enable – This turns on / enables the maintenance mode
 Off Disable – This turns off / disables the maintenance mode.

If you are upgrading Oracle Applications from 10.7/11.0 to 11i, the following options
will also appear along with the 11i options above.

• 10.7 Download – downloads and unzips the patch

• 10.7 Apply – Applies the patch
• 10.7 Verify Applied – Verifies the patch application
• 10.7 Restart – Restarts the patch application
• 10.7 Reset – Resets the patch application.
• 11.0 Download – downloads and unzips the patch
• 11.0 Apply – Applies the patch
• 11.0 Verify Applied – Verifies the patch application
• 11.0 Restart – Restarts the patch application
• 11.0 Reset – Resets the patch application

Patch Alerts Email

The Patch Alert Report is to alert you of any ADPATCH errors or the status of the patch
being applied, through E-mail or SMS message. You are sent The Patch Alert Report
based on configuration table values or if you have requested it directly from the Patch
Monitoring portal. Figure 31 shows the different options available with this menu:
Figure 31 Patch Alerts Email Menu Options

Page 42
The menu options provide the following features:

• Start Alert
Starts patch monitoring and sends you an email or SMS message alert for every
frequency period set.
• Stop Alert
Stops patch monitoring and sending of the alert messages.
• Status of Alert
Shows the status of the alert. This also shows the user-defined values and the
default values for each attribute in the User Preferences screen.

The following table lists Patch Alert attributes. You can define or modify an attribute
value in the Update Profile screen. For more information on this screen, see Updating a
User Profile.

Attribute Name Default Value Options Meaning

PATCH_ALERTS_START NO YES,NO Start Patch Monitor

_MONITOR automatically to send e-mails
based on NOTIFY_WHEN
setting
PATCH_ALERTS_EMAIL ‘EOF_USER.EM EOF_USER.EM Patch Failure Send to address:
_ADDRESS AIL_ADDRESS’ AIL_ADDRESS EOF_USER.EMAIL_ADDRESS
or a real e-mail or a vaild e-mail or SMS address
address
PATCH_ALERTS_EMIAL LONG LONG or Type Patch Failure message is
_TYPE SHORT SHORT for SMS or LONG for
Note: Other email with more details
options may be
availbale in the
future.
PATCH_ALERTS_FREQ_ 5 Minutes The number of minutes to wait
MINUTES (number) between monitoring
PATCH_ALERTS_NOTIF ‘WORKER_OR_ ADPATCH_ST Patch Failure Alert type is used
Y_WHEN ADPATCH_ST OPPED, to define when to send an email.
OPS’ WORKER OR By default the Alerting is
ADPATCH complete after a NOTIFY WHEN
STOP, occurs except with
ADPATCH ADPATCH_RUNNING. It sends
RUNNING alerts each FREQ it is executed
and stops only when adpatch
process goes away.

For example, if all attribute values were set to default, a typical flow would be:

1. Apply patch with monitoring set to YES for automatic e-mail notification
(“Patching Alert Email” > “Start Alert”.)
2. Monitoring runs every five minutes (for example), finds that adpatch has shut
down and e-mails a message similar to that shown in figure 29 with the details
of any adpatch and adworker jobs.
3. You find the problem, restart adpatch, and go back to the end of the e-mail and
click the restart link or use the Patch Monitor to restart the current “Patching
Alert Email”.
4. Repeat as needed.

The e-mail report will show the patch number and the failure type in the subject. A link
at the end of the report will allow you to restart monitoring.

Page 43
Figure 32 Email Report

HEADER
SUBJECT: Patch Monitoring Report for: 3649470, Type:
WORKER_OR_ADPATCH_STOPS
FROM: mwteam@drilnx7.us.oracle.com
DATE: 2:14 PM
TO: steve.andrew@oracle.com

ADPATCH
This section shows if the apatch process is up or not, i.e. the number of adpatch
processes running 1 or 0

ADWORKER
This section shows SQL output from FND_INSTALL_PROCESSES, which includes the
control-codes and status, along with the files currently being processed.
Worker Control_Code Status Command Phase FileName
Start_Time
------ ------------ --------------- -------------------- -----
------------------------------ ------------------
4 E-Error F-Failed UNDEF 0 UNDEF
1 W-Waiting F-Failed UNDEF 0 UNDEF
3 W-Waiting R-Running UNDEF 0 UNDEF
2 W-Waiting W-Waiting UNDEF 0 UNDEF

Page 44
WORKER LOG FILE

##
## Each of the adworkXX.log files tailed below with file size last update date.
##

################################################################################
## Tail File: /vis1155/applmgr/apps/admin/VIS1155/log/adwork01.log
## File Details: Jun 13 16:20: 6921831 bytes
################################################################################
Killed

NOTE: Any patching errors will be converted to links for direct searches to metalink.
Initial login will be required to establish an existing web session! This allows for one
click error searches on any errors in the log files.

SSA_TESTING: "https://metalink.oracle.com/metalink/plsql/f?
p=130:10:3574787221834337847::::ALLTEXT,KNOWLEDGE,ARCHIVE,BUG,FORUMS,ANYTEXT,EXCT
EXT,NONTEXT,DOCID,PRODUCT_ID,PLATFORM_ID,UPDATE,NUMHITS:,TRUE,FALSE,TRUE,TRUE,ORA
-00942: FND_INSTALLED_PROCESSES rest%20AND%203649470,,,,-1,-1,-1,100" REF:
ORA-00942: FND_INSTALLED_PROCESSES rest of line text
…
Warning: Package created with compilation errors.
Time when worker failed: Mon Apr 02 2007 18:26:11

################################################################################

################################################################################
## Tail File: /vis1155/applmgr/apps/admin/VIS1155/log/adwork02.log
## File Details: Apr 2 2007: 6193387 bytes
################################################################################

Connecting to APPLSYS......Connected successfully.

Connecting to APPS......Connected successfully.

Reading jobs to run from restart file.

Completed reading the to-do restart file. Ready to run jobs.

Manager says to quit.

Time when worker quit: Mon Apr 02 2007 18:26:11

AD Worker is complete.

You should check the file

/vis1155/applmgr/apps/admin/VIS1155/log/adwork02.log

for errors.
################################################################################

END OF REPORT

######################################
QUICK SUMMARY:
MW Monitor# PATCH: 3649470 ADPATCH_STATUS: Not_Running WORKERS_FAILED: 2
WORKERS_RUN: 1
######################################
## RESUBMIT_STATUS=NO

OPTION TO RESTART MONITORING

LINK TO START MONITORING AGAIN:

Page 45
Current Patches log

This option displays the last n lines of the current adpatch log, where n is the option
selected under Options > View File Options. The log file is displayed in pages. There are
four buttons that take you the page you wanted to view. The four buttons are

1. Top – Displays the first page.

2. Back – Takes you to the previous page.
3. Next – Takes you to the next page
4. End – Takes you to the last page.

Other than this, there are two buttons below the text area where the log is displayed.

1. Print – Prints the log pages

2. Download – Downloads the log pages to the desktop.

Patch Top Files

This sub-menu displays all the files and the directories inside the patch top directory
recursively. So with this option you can view the entire list of files and directories inside
the patch top with its directory structure.

Patch Readme
This option displays the README.txt file of the patch.

List PATCH_TOP files

This option lists all the files and directories inside the PATCH_TOP directory. This
option will not list the files and directories recursively.

There are four KM-links, which will help you in getting additional information about
the patch

List Worker Logs

This opens the Run OS Commands page, from where you can execute any OS
commands from the tool. It initially lists the worker log files with an ls –l.

Metalink Bug Details

This opens the metalink site to list out all the bugs that are fixed in this patch.

Metalink Articles
This opens the metalink site to list all the articles in the Metalink that are related to this
patch.

Download Site
This will open the Patch home page at updates.oracle.com from where you can
download the patch.

Page 46
Patch Logs
This menu gives the option to list all sorts of log files related to patching. All the log files
that are displayed will just display the last n lines, where n is the number of lines you set
in Options > View File Options. Figure 33 shows the options available under this Patch
Logs menu.

Figure 33 Patch Logs Menu Options

Worker Log
This option displays the worker log information. Clicking this sub-menu displays a table
with two columns, File and Info. The File column lists the name of all AD Worker logs.
The Info column describes the Last updated date and the sizes (in bytes) of all log files.
Click the rows of File column to display their contents. Figure 34 shows the Worker Log
table.

Page 47
Figure 34 Workers Log Table

Click the Refresh button to refresh the contents of the file you selected to display. You
can automatically refresh its content by setting Options > Automatic Refresh to the time
frame you need.

adwork0*.log – Displays the corresponding worker log.

Last 10 CM Requests
This option displays a table similar to the Workers Log table, but will contain the
information related to the Concurrent Requests. The contents of the File column show
the log file names of recently applied 10 CM requests. You can click on the CM request
log file names to display its contents.

Show Errors Only

This option displays the table with different log files related to patching. Clicking the
log files will display the corresponding process error messages, if any.

The tool displays the corresponding log files:

Last Patch log – Log of the last applied patch

Active Patch# log – Log of the active patch
adadmin.log – AD Administration script log
adcrtrl.log – AD Controller log
adjlist.log – adjlist.log
adlibin.log – adlibin.log
adlibout.log – adlibout.log
adpatch.log – Autopatch log
adrelink.log – AD Relink log
APPSORA.env – APPSORA environment file.
adalldefaults.env – adalldefaults environment file.
XML Config File – XML Configuration file.
Patch Tool log file – patch tool log file.

Page 48
Monitoring
This menu can be used to monitor both remote and local machines running processes,
CPU utilisation, disk space, list files in /tmp, and netstat. Figure 35 shows the different
menu options associated with the Monitoring Menu.

Figure 35 Monitoring Menu Options

• Remote Running Processes – Displays the processes running for the current user
on the remote node
• Remote 5 second sar – Displays the CPU Utilisation details each second for five
seconds
• Remote Disk Space – Displays the remote node’s disk space details
• Remote Uptime Report – Displays days and time information on how long the
remote node is up
• Remote /tmp listing – Lists all the files and directories in the /tmp directory of
remote node.
• Remote netstat – Executes the netstat command on the remote node and
displays the result.
• Other OS Commands
• Local Running Processes – Displays the processes running for the current user
on the local Maintenance Wizard node
• Local 5 second sar – Displays the CPU Utilisation details each second for five
seconds
• Local Disk Space – Displays the local node’s disk space details
• Local /tmp listing – Lists all the files and directories in the /tmp directory.
• Local netstat – Executes the netstat command on the local node and displays the
result.

Page 49
SQL
This menu is the place to monitor the database and its related settings. Figure 36 shows
the various menu options available.

Figure 36 SQL Menu Options

• Apps Overview adutconf – This option runs the AD Configuration script

(adutconf.sql), which reports standard information about the installed
configuration of Oracle Applications.
• Monitor AD Worker Table – This option lists the content of
FND_INSTALL_PROCESS table.
• Recently Applied Patches – This option lists all the patches that are recently
applied.
• Current Patchset Levels – Lists patchset levels for all products installed
based on FND_PRODUCT_INSTALLATIONS
• All Applied Patches – Lists all applied patches sorted by recently applied
patches first
• Check Current Patch – Same as 1.2 Monitor Active Patch > AD_TABLES
Statistics
• DB Settings
• DB Sessions
• DB Locks
• DB Space
• DB Invalids
• AD Job Details
• Other SQL Commands – Write your own SQL statement
• R12 Only MSI History – This option will show the MSI History for the
manual steps run by the admsi utility.

Page 50
AD Workers
This is the place to control and monitor the adworker processes during patching. Figure
37 shows the options available under this menu.
Figure 37 AD Workers Menu Options

• View Workers Status

This section shows the SQL output from FND_INSTALL_PROCESSES,
which includes the control-codes and status, and inofmration on what file
each worker is currently processing.

Worker Control_Code Status Command Phase FileName

Start_Time
------ ------------ --------------- -------------------- ----- ----------
4 E-Error F-Failed UNDEF 0 UNDEF
1 W-Waiting F-Failed UNDEF 0 UNDEF
3 W-Waiting R-Running UNDEF 0 UNDEF
2 W-Waiting W-Waiting UNDEF 0 UNDEF

• Show Worker Processes

This option shows the list of Worker processes running on the remote node.
• Set Worker to Fix or Restart
This option will set the worker ready to fix or ready for a restart. This will list
all the workers and you can select any workers you want.
• AD Controller menu options are

AD Controller Menu
---------------------------------------------------

1. Show worker status

2. Tell worker to restart a failed job

3. Tell worker to quit

Page 51
 4. Tell manager that a worker failed its job

5. Tell manager that a worker acknowledges quit

6. Restart a worker on the current machine

7. Exit

• Show Status
This option runs the AD Controller script (adctrl) with option 1to show the
worker status and display its output. AD Controller with option 1 displays a
summary of current worker activity.
• Tell Worker to Restart (fix, restart)
This option runs the AD Controller with option 2, which tells the worker to
restart a failed job.
• Tell worker to shutdown/quit
This option runs the AD Controller with option 3, which tells the worker to
shutdown/quit.
• Tell manager Worker failed its job
This option runs the AD Controller with option 4, which tells the manager
that a worker failed its job.
• Tell Manager worker acknowledges quit
This option runs the AD Controller with option 5, which tells the manager
that a worker acknowledges quit.
• Tell Manager to start a shutdown worker
This option runs the AD Controller with option 6, which tells the manager to
restart a worker on the current machine.
• Tell adpatch to skip workers current job
This option tells the adpatch to skip the workers current job.

Services
You can use this menu to start, stop, or show the status of your application services and
database services, such as the forms server, apps listener, reports listener, concurrent
manager, apache web server, reports review agent, fulfilment server, OA CORE OC4J,
OAFM OC4J, and database listener. It also provides options to start and stop the
database. Figure 38 shows the various options associated with the Services menu.

Figure 38 Services Menu Options

Based on the project you create, this tool populates the respective node’s services option.
For example if your project is to upgrade 11i to R12 the following options will appear.

Page 52
 • 11i Services
• R12 Services
• Database Services

For Apps Database Upg product

• 11i Services
• Database Services

For MP Upgrade product

• 11i Services
• Database Services

For Upgrade to 11i product

• 10.7 or 11.0 Services

• 11i Services
• Database Services

Following are the Services available under each of the above category:

• 10.7 or 11i Services

 Forms Server
 Apache Web Server

• 11i Services

 Forms Server
 Apps Listener
 Reports Listener
 Concurrent Manager
 Apache Web Server
 Start All Services / Stop All Services

• R12 Services

 Forms Server
 Report Review Agent
 Reports Server
 Concurrent Manager
 Apache Web Server
 Applications Listener
 Fulfilment Server
 OACORE OC4J
 OAFM OC4J

• Database Services

 DB Listener Status
 DB Listener Start
 DB Listener Stop
 11i DB Start
 11i DB Stop

Page 53
 Actions performed on these services:

Based on the project you use, you can choose the action that needs to be
performed on each of the above services.

 Status – Shows the current status of the chosen service.

 Start – Starts the chosen service
 Stop – Stops the chosen service

Options
This menu allows for changing default file tail size, font size, active tier, or node to run
command. Figure 39 shows the options avialable under this menu.

Figure 39 Options Menu

• Pick Node
Pick node options will let you to pick the appropriate node to run the rest of
the commands on. You should do this before before you start running any of
this tool’s commands. Based on the project, the following options appear
under this sub-menu.

 Apps
 Conc. Mgr
 Forms
 Web
 Database
 Active Patching Node

For example, the apps node option looks like

10.7 Apps for a 10.7 node

11.0 Apps for a 11.0 apps node
11i Apps for a 11i apps node
R12 Apps for a R12 apps node.

Page 54
 To set the Active node, complete the following:

1. Select the Options menu.

2. Select Pick Node. It will show up the list of nodes.
3. Click the node you want the rest of the patching tool features to execute
its command on.

• View File Options

This option sets the number of lines viewed for a log file. You can select any
of the following:

• Last 20 Lines
• Last 100 Lines
• Last 200 Lines
• Last 500 Lines
• Last 1000 Lines
• Last 5000 Lines
• Show Full File

• Automatic Refresh
This sub-menu can be used to set an automatic refresh of the log file you are
viewing, which is particularly useful when viewing the status of the patch
you are currently applying. You can select any of the following refresh rates:

• Every 5 Secs – default

• Every 10 Sec
• Every 20 Sec
• Every Minute
• Every 2 Minutes
• Every 5 Minutes

• Start Refresh
Starts the log file view refresh for the period set using the Automatic Refresh
utility. You can use key 4 to start the refresh. Once you start the refresh, a
refresh counter will be displayed which shows the number of times the
refresh has been performed.

• Stop Refresh
Stops the log file view refresh. You can also use key 6 to stop the refresh.

• Single refresh
If you want to refresh the log file view only once, you can select this option.
You can also use Key 5 to select this option.

• Font Size
Font Size menu is used to set the font size of the log files that are viewed.

Page 55
Help

Most of the help options are links to key documents and web sites supporting MW, EBS,
or the researching of patch issues. Figure 40 shows the options available under this
menu.

Figure 40 Help Menu Options

Documentation links that are relevant to the upgrade being performed are displayed.

• EBS Docs
• EBS – Using Rapind Install
• EBS – Maintenance Procedures
• EBS – Maintenance Utilities
• EBS – Upgrade Guide
• EBS – eTRM

Other Common links are

• Print Screen – Prints the current patching tool screen.

• Google Search – Link to google search
• Metalink – Link to metalink
• About Patching tool – Provides a brief summary of the patching tool and its
key menu options.

Page 56
Troubleshooting Maintenance Wizard

• Check Your Installation

To verify your new Maintenance Wizard installation:

1. Check that the Apache server is up and running. Enter the following URL in
a Web browser:

http://yourhost.yourdomain:yourport

The Oracle Application Server page appears similar to Figure 41. If this page
does not appear, follow the next step to start the Apache server.

Figure 41 Oracle Application Server

2. The Apache server must be running before you can log in to Maintenance
Wizard. To start the Apache server, enter the following URL in the Web
browser:

http://yourhost.yourdomain:yourport/EOF/

The Web browser redirects to a URL similar to the following:

http://yourhost.yourdomain:yourport/pls/EOF/Eof_Http.html_frames?
p_frame_set_id=LOGIN

The Maintenance Wizard Login page appears. If the Login page does not
appear, then you do not have a successful installation. To troubleshoot this
issue, use the Maintenance Wizard collector script as described in the next
section.

Page 57
 • Use the Collector Script to Gather Debug Information for Installation Issues

The Maintenance Wizard Collector script gathers information that Oracle

Support requires for debugging your installation issue. The collector script
produces a ZIP file that you can upload with your TAR.

To run the collector script:

1. Log in to the operating system of the Maintenance Wizard node as the

Maintenance Wizard owner.

2. Change directory to the $EOF_HOME/scripts/COMMON directory.

Note: $EOF_HOME is set to the directory where you unzipped Maintenance

Wizard.

3. Run the collector script (cant_login.sh) as follows:

$ ./cant_login.sh

The script prompts you for the following information as illustrated in Figure
42:

Figure 42 Running the Collector Script

4. Enter the full path to the EOF_HOME directory.

5. Enter the user name for the Maintenance Wizard schema.

6. Enter the password for the Maintenance Wizard schema.

The collector script produces output similar to Figure 43.

Page 58
Figure 43 Collector Output

• Check Your Project Configuration

If you defined a project in Maintenance Wizard and cannot achieve the

Configuration Complete status, use the Maintenance Wizard Collector script to
gather information about the installation and the project configuration as
described in the following section.

• Use the Collector Script to Gather Debug Information for Project Configuration
Issues

The Maintenance Wizard Collector script gathers information that Oracle

Support requires for debugging your installation issue. The collector script
produces a ZIP file that you can upload with your TAR.

To run the collector script:

1. Log in to the operating system of the Maintenance Wizard node as the

Maintenance Wizard owner.

2. Change directory to the $EOF_HOME/scripts/COMMON directory.

Note: $EOF_HOME is set to the directory where you unzipped Maintenance

Wizard.

3. Run the collector script (cant_config.sh) as follows:

$ ./cant_config.sh

Page 59
Figure 44 Running the Collector Script

4. The script prompts you for the following information

 Full path to the EOF_HOME directory.
 User name to the Maintenance Wizard schema.
 Password to the Maintenance Wizard schema.
 Instance ID for the project with which you are having issues.
The collector script produces output similar to Figure 30.
Figure 45 Collector Output

Page 60
Using the OS and SQL Utilities

You can use the OS and SQL utilities integrated in Maintenance Wizard to perform
various remote commands in a simple and convenient way. This saves time and
effort because you do not have to open a separate tool, log in, source the correct
environment files, and enter the relevant command to view a specific file or to check
the results of a query.

To run the OS Commands utility or SQL Query utility, complete the following:

1. Log in as the Upgrade Engineer.

Note: You must have the appropriate responsibility for the current project to
run these utilities. For more information about granting OS Command
Access and SQL Query Access, see step 5 of Step 7: Assigning
Responsibilities to Users.

2. From the Process tab, select Utilities.

The Utilities page appears, similar to Figure 53.

Depending on the utility that you want to use, select one of the following:

• Run OS C ommands
• Run SQL
• Run OS Commands

To run OS commands, complete the following:

1. From the Ebiz Support list, click Run Os Commands.

The OS Commands utility page appears similar to Figure 46.

Figure 46 Run OS Commands

2. In the Command field, enter the OS command that you want to run.

Page 61
 3. From the Host list, select the node on which you want to run the OS
command and click Submit.
The OS Command page appears similar to Figure 47.

Figure 47 OS Commands Results

To Run SQL Queries, complete the following:

1. From the Ebiz Support list, click Run SQLs.
The SQL Query utility page appears similar to Figure 48.

Figure 48 Run SQL Query

Page 62
 2. In the Run SQL text field, enter the SQL query that you want to perform. For
information about SQL Queries, see the example following this section.

3. From the Flip columns list, select the format in which to view the results,
then click Submit.

Examples for Using the OS Command and SQL Query Utility

For a detailed description of these utilities, see Appendix C: Examples for Using the
OS Command and SQL Query Utility.

Applications patching provides an example of when and how to use the OS and SQL
utilities.

These utilities can be helpful during the execution of a long patch or in trying to
diagnose a patch that has failed or is stuck.

The following are a number of useful SQL examples:

select CONTROL_CODE, STATUS

from fnd_install_processes@REMOTE

select patch_name, patch_type, creation_date

from ad_applied_patches@REMOTE

order by creation_date desc

select fa.application_short_name, fpi.STATUS, fpi.PATCH_LEVEL

from fnd_product_installations@REMOTE fpi, fnd_application@REMOTE fa

where fpi.application_id = fa.application_id

order by 1

Typical useful OS examples are as follows:

tail -100 $APPL_TOP/admin/$TWO_TASK/log/adwork001.log

ls –lrt $APPL_TOP/admin/$TWO_TASK/log/

tail -100 $APPL_TOP/admin/$TWO_TASK/log/adwork001.log adrelink.log

grep –i error $APPL_TOP/admin/$TWO_TASK/log/adwork001.log

$ORACLE_HOME/bin/tnsping $TWO_TASK

ps –ef | grep pmon

ps –ef | grep lsnr

tnsping $TWO_TASK

ls –l$APPL_TOP/admin

Page 63
About Reporting

Run System or Project Administration Reports

Use the Configuration page to create system and project administration reports.

To run reports, complete the following:

1. Log in as the System or Project Administrator.

The Customer Configuration page appears similar to Figure 2.

2. Click Configuration, then click the Reports subtab.

The Reports page appears, similar to Figure 49.

Figure 49 Reports Page

3. From the Select Report list, select the report that you want to view:
Note: The reports available to you depend on your role.

• Customer Projects: Displays the status of each project for each customer.

• Projects Assigned: Displays the projects assigned to the selected

Upgrade Engineer.

• Node Configuration Details: Displays the node information and

runtime configuration information for the selected project.

• Project Configuration Details: Displays the project level configuration

information for the selected project.

• Responsibility Assignments: Displays the tasks assigned to each

Upgrade Engineer for the selected project.

• Audit Trail: Displays the main events that occurred for the sleeted
project.

• Assigned Engineers: Displays the Upgrade Engineers assigned to the

selected project.

Page 64
 • Monitor Logins: Displays the number of logins to the selected project for
the duration of 1 day, 2 days, a week, or the lifetime of the project. Select
the duration from the No of Days list.

• Monitor Upgrades: Displays the progress of the upgrade for the selected
project

Note: Click the Summarization Spreadsheet link to generate a spreadsheet

that contains all of the timing data for your project. The report can be run in
“Show last executions only” mode, which includes only the most recent time
data, or “Show all executions” mode, which sums the times of all executions.

Run Engineer Reports

Upgrade Engineers can view a List of Assigned Steps report, which displays all of the
steps that are currently assigned to the engineer. Steps that appear in red indicate
that the step was not marked as Success or Redo and must be addressed.

To view a List of Assigned Steps report, complete the following:

1. Log in as the Upgrade Engineer.

The Roles page appears.
2. From the Engineer list, select the required project.
The Process page appears, similar to Figure 13.
3. From the Process page, click the Reports subtab.
4. From the Select Report list, select List of Assigned Steps.
The report appears similar to Figure 50.

Figure 50 List of Assigned Steps

Page 65
Running Live Patch and Live Update
You can use Live Patch and Live Update to maintain the latest version of
Maintenance Wizard as follows:

• Download and Run Live Patch

• Update Existing Projects Using Live Update

• What to Do if the Live Update or Live Patch Fails

Download and Run Live Patch

The Maintenance Wizard Live Patch enables you to upgrade the current version of
Maintenance Wizard without overwriting any configuration information previously
gathered.

To view LivePatch, complete the following:

1. Log in as the System Administrator.

The Customer Configuration page appears.

2. From the Configuration tab, click LivePatch.

The LivePatch page appears, similar to Figure 51.

Figure 51 LivePatch Page

If the version numbers are the same or the current is higher, then no automated LP is
available.

Page 66
 3. If a later version of LivePatch for Maintenance Wizard is required, click Run
Automatic LivePatch now.

Note: If the Latest Live Patch Version has a value of UNKNOWN, it is possible that
you may not have provided valid information during installation and you made need
to manually fix the .nertc file. Alternatively, you may be experiencing Internet
access issues.

For more information about LivePatch, see How to Perform a Live Patch in Metalink
note 291887.1

Note: You must run Live Update after a LivePatch to view the effects. For
information about LiveUpdate, see Update Existing Projects Using Live Update.

Note: Occasionally a LivePatch is released that requires manual application as

described in Metalink note 291887.1

Update Existing Projects Using Live Update

Only System Administrators can update existing projects with Live Update.

To update an existing project, complete the following:

1. Log in as the System Administrator.

The Customer page appears.

2. From the Configuration tab, click the Liveupdate secondary tab.

The Liveupdate page appears similar to Figure 52.

Page 67
Figure 52 Liveupdate Page

3. From the Project to Liveupdate list, select the project that you wish to update
and then select the source project from which you wish to update. Select the
Master project, unless you have a customized project that you want to
replicate. Then click Liveupdate. Alternatively, click LiveUpdate All to
update all projects.

What to Do if the Live Update or Live Patch Fails

If a Live Update or Live Patch fails, you must restore your project from the back up
that you created. Contact Oracle Support for assistance when performing the restore.

Page 68
Administering Maintenance Wizard
Note: When you update an administration option, it affects all users and projects.

There are a number of administration tasks available to the System Administrator:

• Filtering steps

From the Step Filter list, select Use Filter to omit steps that are not applicable
to your upgrade project. If you do not use the Step Filter feature, then you
will see many steps in your projects that do not apply to your project.
Usually, this is only used for debugging purposes. Click Save to save your
options.

• Displaying icons for completed steps

From the Icon for “Automatically Completed” Steps list, select Show symbols
to enable Maintenance Wizard to display the Red Circle with Slash icon
described in About the Maintenance Wizard Interface. If you do not select
this option, there will be no icons under the Setup, Execute, and Validate
columns on the Process tab for Automatically Completed steps. Click Save to
save your options.

• Setting Debug

From the System level DEBUG option list, select Show debugging to display
debug information for all projects. Otherwise, select Hide debugging to hide
the debug information. Click Save to save your options.
Note: You can override this setting at the Project level. For more information,
see Debug Task on page 82.

• Hiding Passwords in Maintenance Wizard Output

From the Mask passwords in output list, select Mask passwords to hide or
obfuscate passwords in the Maintenance Wizard output. Otherwise, select
Show passwords to display passwords in the Maintenance Wizard output.
Click Save to save your options.
Note: When Maintenance Wizard hides your password, it hides all
occurrences of that word. If your password is a common word, then
Maintenance Wizard hides all occurrences of that word in the Maintenance
Wizard output.

• Deleting customers from Maintenance Wizard

From the Delete Customer table, beside the customer that you want to
delete, click Delete. Click OK to confirm your action.

• Deleting projects from Maintenance Wizard

From the Delete Project table, beside the project that you want to delete,
click Delete. Click OK to confirm your action.

Page 69
Appendix A: Maintenance Wizard Common Tools

Traditional Approach to the Upgrade for UNIX

The traditional approach for upgrading on UNIX is to perform all upgrade steps
manually using information from the Upgrading Oracle Applications Manual, Release
Notes and the Upgrade Assist Worksheet. The person performing the upgrade must do
the following:

• Browse through all applicable information manually

• Keep a manual log of all steps and their success or failure

• Perform data validation manually (without documentation assistance)

• Manually gather and submit all applicable log files with SRs (if necessary)

New Approach to the Upgrade for UNIX

Maintenance Wizard guides you through the Oracle Application Upgrade process.
The tool presents the upgrade as a step-by-step process by consolidating all upgrade
references together. It enables the validation of each step, tracks the completion of the
step, and maintains a log and status. It is a multi-user tool that enables the System
Administrator to give different users upgrade assignments based on any combination
of category, product family, or task level. It also provides upgrade project
management utilities to record the time taken for each task, completion status, and
project reporting.

The tool does not replace any code in the current or future Oracle e-Business
Applications code.

Improve System Performance During the Upgrade

The upgrade may require more database server resources than normal runtime
usage. You can improve performance by installing the administration server on a
different machine than the database server, thereby allowing more CPUs to
participate in the upgrade.

System Preparation

Clone your system. Create an identical copy of an existing Oracle Applications

system to use in the upgrade. Refer to Cloning Your System in the Oracle Applications
AD Procedures Guide for details.

Page 70
Merge and Apply Patches

This version of Maintenance Wizard includes a patch application tool that can
download and apply patches on both the source and target project. If a step requires
you to apply a patch, the tool is used in the Setup-Execute-Validate framework to
perform the following:

• Setup
The patch tool checks to see if the patch has already been applied. If the
patch is already applied, then no further action is necessary. You can mark
the Setup, Execute and Validate portions of this step as successfully
completed. If the patch has not yet been applied, then this step downloads
the patch and copies it to all relevant nodes for installation. It then unzips the
patch and displays the readme.txt file. Read readme.txt carefully to
determine if there are any manual actions that you need to perform.
Maintenance Wizard checks these manual actions by running admsi.pl and
then displays the results in a newly-generated readme file based on the
existing system.

Note: Patches are loaded in order, so all prerequisites for a patch are applied
in previous steps. Errors encountered during the Setup phase are usually due
to one of the following:

o An invalid MetaLink User ID or Password in the configuration of

Maintenance Wizard.

o An obsolete or deleted patch number

If this occurs, log in to OracleMetaLink and download the patch manually.

• Execute
The patch tool applies the patch to all appropriate nodes. Review the log file
for this step carefully to ensure that the patch applied without errors. If there
are errors in the log file and the cause of the errors can be corrected, restart
the patch application as follows:

1. From the Process tab, click the Utilities subtab.

The Utilities page appears similar to Figure 53.

Page 71
Figure 53 Utilities Page

2. Select Step 2-Apply a patch.

3. When prompted, select YES to restart a failed patch application?

Note: You can also choose to have the DBA manually reapply the patch
using the adpatch utility. When this is complete, mark the Execute step as
manually completed, and proceed to the Validate step.

• Validate
The patch tool verifies that the patch was successfully applied. If the log file
shows the patch was not successfully applied, then have the DBA manually
reapply this patch using the adpatch utility. When this is complete, repeat
this Validate step. Do not proceed to the next step until the script shows that
the patch has been successfully applied.

Merge Patches

The tools also include a patch merge utility. Merging makes it easier to apply the
large number of patches required by Maintenance Wizard, because it considers
prerequisites already and applies the patches in the correct order. It also saves a lot of
time by eliminating duplicate jobs that would normally run once per individual
patch, but now run only once per merged patch. Often, multiple patches required for
the upgrade are dynamically grouped into merged patches, then each merged patch
is applied. This capability reduces the time required to apply the patches.

Page 72
About the Utilities Category

The Utilities Category contains a collection of steps that you can use to perform
activities such as applying a patch, recompiling invalid objects, and starting or
stopping a service. You are not required to use this category to perform the upgrade.
However, these steps are provided to assist you in special cases where you need to
perform a general command that is not specifically listed in the Upgrade manual. The
Utilities Category steps are divided into four types:

• Patching

• Administer Services

• View Information

• MW Tool

About Patching Tasks

The Patching Steps are divided between two tasks:

• Patching for all Releases Task

• Additional Utilities for Rel 11i and 12 Only Task.

Patching for all Releases Task

Use the steps under this task to download, apply, and verify a patch on either the
source or target project. These steps prompt you for necessary parameters and then
perform the patch function. There is also a step to recompile invalid objects. The
individual steps are as follows:

• STEP 1 - Download a patch

This step performs one of the following:

o Verifies that the patch has been downloaded to the EOF node and
has been copied to the specified target node(s),

o Downloads the patch to the EOF node and copies it to the specified
target node(s). If successful, it displays the readme.txt file. Then
Maintenance Wizard runs the Manual Step Infrastructure script
(admsi.pl) to generate the final readme after checking for any
completed manual steps. Prompt/Parameters are:

1. What release is the patch for? (10.7, 11, 11i, 12)

2. Enter the Patch Number

3. Force the patch to download even if it is already applied? (Yes/

No)

4. Turn debug mode on? (Yes/No)

Page 73
 • STEP 2 - Apply a patch

This step applies a patch that has already been downloaded. It includes a
Parameter to restart a failed patch. Prompt/Parameters are as follows:

1. What release is the patch for? (10.7, 11, 11i. 12)

2. Enter the Patch Number

3. Force the patch to install? (Yes/No)

4. Restart a failed patch application? (Yes/No)

5. Number of workers? (default is 3)

6. Apply in preinstall mode? (Yes/No)

7. Enter driver filename or all. (default is all)

8. Turn debug mode on? (Yes/No)

9. Reapply an already applied patch? (Yes/No)

10. Specify options

• STEP 3 - Verify patch application

This step verifies the application of a patch. Prompt/Parameters are as

follows:

1. Release to apply patch to? (10.7, 11, 11i, 12)

2. Patch Number

3. On which node would you like to check for application? (Applications

node, Forms node, Concurrent manager node, Web node)

4. Turn debug mode on? (Yes/No)

Additional Utilities for Rel 11i and 12 Only Task

The step under this task enables you to merge and apply more than one patch. This
utility is used in the Post-MP Patching to apply all the patches needed to the 11i or 12
projects after the data has been migrated. It is available from the Utilities Category if
you need to apply multiple patches to the 11i and 12 projects.

• STEP 1 - AD Merge Patch and Apply

This step comprises two sub steps, Setup and Execute.

1. Setup

The setup step downloads the given list of patches and merges them into
one big patch. It then copies the newly created merged patch to all
appropriate nodes and unzips it. This utility takes the following
parameters:

Page 74
  Patch Version; either 11i or 12

 A list of patch numbers separated by commas or a filename that

contains patch numbers, one per line

 A flag that indicates if you want to force the download, even if the
patch is already applied

Prompt/Parameters are:

1. What release are the patches for? (11i/12)

2. Enter Patch List File or patch numbers separated by commas

3. Do you want to force download even if already applied? (Yes/No)

4. Turn Debug mode on? (Yes/No)

2. Execute

This script applies a merged patch that was previously downloaded and
unzipped on the remote tiers via the setup step.

Prompt/Parameters are:

1. What release are the patches for? (11i/12)

2. Turn Debug mode on? (Yes/No)

• STEP 2 – Alter Maintenance Mode

This step alters the maintenance mode setting. You must provide the
required parameters to indicate the version of the Applications and to enable
or disable the maintenance mode setting. Prompt/Parameters are:

1. For which release do you wish to change Maintenance Mode? (11i, 12)

2. Turn Maintenance Mode on or off (On, Off)

• STEP 3 – Reset incomplete patching attempt

This step resets an incomplete or failed patching attempt.

Prompt/Parameters are:

1. For which release do you wish to reset an incomplete patching attempt?

(11i, 12)

• STEP 4 – Control adworker

This step performs a single action using adctrl. Prompt/Parameters are as

follows:

1. For what release do you wish to control the adworker? (11i, 12)

2. Which action do you wish to perform? (Show worker status, Tell worker
to restart a failed job, Tell worker to quit, Tell manager that a worker
failed its job, Tell manager that a worker acknowledges quit, Restart a

Page 75
 worker on the current machine, Tell worker to skip the current job (only
with Support approval)

3. Which worker do you wish to perform the action on? (1, 2, 3, 4, 5, 6, 7, 8,

9, 10, all)

• STEP 5 – Perform adadmin action

This step performs a single action using adadmin. Prompt/Parameters are as

follows:

1. For which release do you want to run adadmin? (11i, 12)

2. Which action do you wish to perform? (Relink Applications programs,

Generate message files, and so on)

3. How many workers do you wish to use?

About Administer Services for the database

The group of steps under the task Administer services for the database enables you
to perform basic service functions.

• STEP 1 - Administer the database

This step either stops or starts the database automatically. You must provide
two parameters. The first tells it whether to start or stop the service. If you
choose to stop the database, then you must also specify whether to shutdown
in normal, immediate or abort mode. If you do not specify a shutdown
mode, it uses normal mode. Prompt/Parameters are:

1. On which database node do you wish to perform the operation?

(Database node)

2. What action do you want to do to the database? (Start, Stop)

3. If shutting down, which mode do you want to use? (Normal, Immediate,

Abort)

• STEP 2 - Administer the database listener

This step stops or starts the database listener automatically. You must
provide one parameter to start, stop, or show the status of the service.
Prompt/Parameters are:

1. On which database node do you wish to perform the operation?

(Database node)

2. What action do you want to do to the database listener? (Show status,

Start, Stop)

Page 76
About Administer Services

The group of steps under the task Administer services enables you to perform basic
service functions.

Administer Services for Rel 10.7

This group of steps allows you to perform basic operations on the services.

• STEP 1 - Administer the 10.7 concurrent manager

This step administers the Release 10.7 concurrent manager. You can specify
whether to start, stop or show the status of the service. If you choose stop,
you must specify a valid Applications username with permission to shut
down the concurrent manager. Prompt/Parameters are:

1. What action do you want to do to concurrent manager? (Show Status,

Start, Stop)

2. If you choose “Stop” enter a username that has the System Administrator
responsibility

• STEP 2 - Administer the 10.7 forms Server

This step administers the forms listener automatically. You must provide one
parameter, which starts, stops or shows the status of the service.
Prompt/Parameters are:

1. What action do you want to do to the forms listener? (Show Status, Start,
Stop)

• STEP 3 - Administer the 10.7 web server

This step will administer the Release 10.7 OWS listener. Specify whether to
start, stop or show the status of the service. Prompt/Parameters are:

1. What action do you want to do to the OWS listener? (Show Status, Start,
Stop)

Administer Services for Rel 11

This group of steps allows you to perform basic operations on the services.

• STEP 1 - Administer the OWS listener for release 11

This step will administer the Release 11 OWS listener. Specify whether to
start, stop or show the status of the service. Prompt/Parameters are:

1. What action do you want to do to the OWS listener? (Show Status, Start,
Stop)

• STEP 2 - Administer the forms Server for release 11

This step administers the forms listener automatically. You must provide one

Page 77
 parameter, which starts, stops or shows the status of the service.
Prompt/Parameters are:

1. What action do you want to do to the forms listener? (Show Status, Start,
Stop)

• STEP 3 - Administer the concurrent manager for release 11

This step administers the Release 11 concurrent manager. You can specify
whether to start, stop or show the status of the service. If you choose stop,
you must specify a valid Applications username with permission to shut
down the concurrent manager. Prompt/Parameters are:

1. What action do you want to do to concurrent manager? (Show Status,

Start, Stop)

2. If you choose “Stop” enter a username that has the System Administrator
responsibility

Administer Services for Rel 11i

This group of steps allows you to perform basic operations on the services.

• STEP 1 - Administer the Apache listener for Rel 11i

This step either stops or starts the Apache service automatically. You must
provide one parameter that starts, stops, bounces (stops and restarts), or gets
the status of the service. If you choose either the start or bounce option, it
also clears the cache before starting Apache. Prompt/Parameters are as
follows:

1. What action do you want to do to Apache? (Show Status, Start, Bounce,

Stop)

• STEP 2 - Administer the forms listener for Rel 11i

This step administers the forms listener automatically. You must provide one
parameter, which starts, stops or shows the status of the service.
Prompt/Parameters are:

1. What action do you want to do to the forms listener? (Show Status, Start,
Stop)

• STEP 3 - Administer the reports listener for Rel 11i

This step administers the reports listener automatically. You must provide
one parameter, which starts, stops or shows the status of the services.
Prompt/Parameters are:

1. What action do you want to do to the reports listener? (Show Status,

Start, Stop)

Page 78
 • STEP 4 - Administer the concurrent manager for Rel 11i

This step administers the concurrent manager automatically. You must

provide one parameter, which starts, stops or shows the status of the service.
Prompt/Parameters are:

1. What action do you want to do to the concurrent manager? (Show Status,

Start, Stop)

• STEP 5 - Administer the applications listener for Rel 11i

This step administers the applications listener automatically. You must

provide one parameter, which starts, stops, or shows the status of the service.
Prompt/Parameters are:

1. What action do you want to do to the concurrent manager? (Show Status,

Start, Stop)

• STEP 6 - Administer all applications services for Rel 11i

This step stops or starts all of the Release 11i services automatically. You
must provide one start or stop parameter. Prompt/Parameters are as follows:

1. What action do you want to do to all of the applications services? (Start,

Stop)

Administer Services for Rel 12

This group of steps allows you to perform basic operations on the services.

• STEP 1 - Administer the Oracle HTTP Server (OHS) for Rel 12

This step either stops or starts the Apache service automatically. You must
provide a parameter to start, stop, bounce, or get the status of the Apache
service. Prompt/Parameters are as follows:

1. What action do you want to do to Apache (Show status, Start, Bounce,

Stop)

• STEP 2 – Administer the forms listener for Rel 12

This step administers the forms listener automatically. You must provide
one parameter that starts, stops, or gets the status of the service.
Prompt/Parameters are as follows:

1. What action do you want to do to the forms listener? (Show status, Start,
Stop)

• STEP 3- Administer the OACORE OC4J for Rel 12

This step administers the OACORE OC4J automatically. You must provide
one parameter that starts, stops, or gets the status of the service.
Prompt/Parameters are as follows:

1. What action do you want to do to the OACORE OC4J? (Show status,

Start, Stop)

Page 79
 • STEP 4 – Administer the OAFM OC4J for Rel 12

This step administers the OAFM OC4J automatically. You must provide one
parameter that starts, stops, or gets the status of the service.
Prompt/Parameters are as follows:

1. What action do you want to do to the OAFM OC4J? (Show status, Start,
Stop)

• STEP 5 – Administer the Fulfillment Server for Rel 12

This step administers the Fulfillment server automatically. You must provide
one parameter that starts or stops the service. Prompt/Parameters are as
follows:

1. What action do you want to do to the Fulfillment server? (Start, Stop)

• STEP 6 – Administer the concurrent manager for Rel 12

This step administers the concurrent manager automatically. You must

provide one parameter, which starts, stops or shows the status of the service.
Prompt/Parameters are as follows:

1. What action do you want to do to the concurrent manager? (Show Status,

Start, Stop, Abort)

• STEP 7 – Administer the applications listener Rel 12

This step administers the applications listener automatically. You must

provide one parameter, which starts, stops, or shows the status of the service.
Prompt/Parameters are as follows:

1. What action do you want to do to the applications listener? (Show status,

Start, Stop)

• STEP 8 – Administer all applications services for Rel 12

This step stops or starts all of the Release 12 Applications services

automatically. You must provide one start or stop parameter.
Prompt/Parameters are as follows:

1. What action do you want to do to all of the applications services? (Start,

Stop)

About View Information

This group of steps enables you to view concurrent request and logs files.

Concurrent Request
These steps enable you to view the concurrent request output and logs:

• STEP 1 - View concurrent request output file

This utility shows you the concurrent request output file for a concurrent job.

Page 80
 You must enter the concurrent request ID as a parameter, as well as the
version of the Applications to which the job was submitted

Note: If a concurrent request was submitted before running Auto Upgrade,

you should choose the release from which you are upgrading. If a concurrent
request was submitted after running Auto Upgrade, then you should choose
12 as your release.

Prompt/Parameters are as follows:

1. What release is the concurrent request for? (10.7, 11, 11i, 12)

2. Concurrent Request ID?

• STEP 2 - View concurrent request log file

This utility shows you the concurrent request log file for a concurrent job.
You must enter the concurrent request ID as a parameter, as well as the
version of the Applications to which the job was submitted.

Note: If a concurrent request was submitted before running Auto Upgrade,

you should choose the release from which you are upgrading. If a concurrent
request was submitted after running Auto Upgrade, then you should choose
12 as your release.

Prompt/Parameters are as follows:

1. What release is the concurrent request for? (10.7, 11, 11i, 12).

2. Concurrent Request ID?

Log Files
These steps enable you to view the patch and worker logs:

• STEP 1 - View patch application log file

This utility displays a patch application log file. It requires two parameters:
the patch number and the node location of the log file. This utility does not
work for 10.7 Smart Client patches. Prompt/Parameters are as follows:

1. What release is this patch for? (10.7, 11.0, 11i, 12)

2. Enter the patch number

3. Node to view the log for? (Applications node, Forms node, Concurrent
Manager node, Apache node)

• STEP 2 - View a worker log file

This utility displays a worker log file. It requires four parameters: the worker
number, the node on which you were running the AD utility, the amount of
the file you wish to have displayed, and whether the worker is a pre-upgrade
or post-upgrade worker. Prompt/Parameters are as follows:

1. What release is the patch for? (10.7, 11.0, 11i, 12)

Page 81
 2. Enter the worker number

3. Which node was running the AD utility? (Applications node, Forms

node, Concurrent Manager node, Apache node)

4. How much of the file do you wish to see? (50 lines, 100 lines, 500 lines,
1000 lines, Entire file – not recommended)

Database Queries

• STEP 1 - View database parameter value (Optional)

This step displays the value of any database parameter in the v$parameter
table.

Prompt/Parameters are as follows:

1. Choose which database parameter to view the value for (Select from
LOV prompt)

About MW Tool

Debug Task
This step assists with debugging:

• STEP 1: Alter debug mode in MW

This step toggles the debug flag for the current project only. This setting
overrides the system level debug setting. When set to Yes, additional
diagnostic messages are recorded in the log during execution.
Prompt/Parameters are as follows:

1. Use debugging? (No, Yes)

MW Setup Task
This step assists with setting up Maintenance Wizard:

• STEP 1: Change password for EOFUSER

This step changes the password for the database user EOFUSER and for all
the associated configuration files that require updating. It restarts Oracle
Process Management and Notification (OPMN) for the new data to take
effect. Prompt/Parameters are as follows:

1. Provide the current password for the EOFUSER

2. Provide the new desired password for EOFUSER

Note: Maintenance Wizard does not display the password when you enter it
on the page.

Page 82
• STEP 2: Change number of workers for AD Utilities

The Maintenance Wizard automates some of the AD utilities such as

adadmin and adpatch. In doing so, it will use a default number of workers of
6 for these process. If you would like to change the number of default
workers to another value for your project, run this step and provide the
desired number of workers. Prompt/Parameters are as follows:

1. How many workers do you want to use

Note: This value is set at the project level, so if you wish to change the
default number of workers for a different project, please run this Utility from
that project's responsibility.

Page 83
Appendix B: Product Specific Information for Maintenance Wizard

Note to 10.7 Customers

When you create your upgrade project, you specify that your source version is 10.7.
At this point, the tool does not ask whether you are NCA, SC or character. You are
not prompted for this information until you have completed project definition and
are actually in the Configuration category of the tool. When you begin node
definition, you are prompted for the following values, which are only applicable to
NCA customers:

• Release 10.7 NCA $APPL_TOP path

• Release 10.7 NCA patch directory path

• Release 10.7 NCA ORAWEB_HOME path

• Release 10.7 NCA forms port number

• Release 10.7 NCA (OWS) listener name

If you are an NCA customer, fill in the appropriate values., otherwise, enter any non-
null value (such as X) into these fields, as they will not be used once you specify your
10.7 type.

Variables to Use for Customization

#Start of a Local Instance File

PRODUCT_ID #Product ID

INSTANCE_ID #Project ID

REMOTE_EOF_HOME #Directory created under remote Hosts

EOF_SCRIPTS #Directory where scripts are located

EOF_HTML #Directory containing Product specific HTML file

EOF_LOG #Log Directory for the project

EOF_CONFIG #Config Directory for the project

EOF_CUSTOM #Directory for customized scripts

EOFUSER #User on the local Maintenance Wizard database

EOFPASSWORD #Password for the EOF_USER

TNS_ADMIN

HOME #$EOF_HOME/config

Page 84
LD_LIBRARY_PATH #The LD_LIBRARY_PATH on the remote node

APPLSYSUSER

APPLSYSPASSWORD

APPSUSER

APPSPASSWORD

SYSTEMUSER

SYSTEMPASSWORD

# 11i Admin Node Remote Node environment variables

REMOTE115_APP_PATCH_TOP #Directory to download patches

REMOTE115_APP_HOME #APPL_TOP

REMOTE115_APP_DB_HOME #Apps Tools ORACLE_HOME

REMOTE115_APP_NODE #Machine

REMOTE115_APP_USER #User

REMOTE115_APP_PLATFORM #Platform

REMOTE115_APP_ENV_FILE #Applications environment filename

REMOTE115_APP_CONTEXT #AutoConfig context name

REMOTE115_APP #Remote Agent

REMOTE115_APP_SHELL_TYPE #Either RSH or SSH

REMOTE115_APP_CONTEXT_LOC #Location of AutoConfig file

REMOTE115_APP_FTPEXE #Either ftp or sftp

REMOTE115_APP_CPEXE #Either rcp or scp

REMOTE115_APP_SHEXE #Either rsh, remsh, or ssh

# 11i Concurrent Manager Node Remote Node environment variables

REMOTE115_CM_PATCH_TOP #Directory to download patches

REMOTE115_CM_HOME #APPL_TOP

REMOTE115_CM_DB_HOME #Apps Tools ORACLE_HOME

REMOTE115_CM_NODE #Machine

REMOTE115_CM_USER #User

REMOTE115_CM_PLATFORM #Platform

Page 85
REMOTE115_CM_ENV_FILE #Applications environment filename

REMOTE115_CM_CONTEXT #AutoConfig context name

REMOTE115_CM #Remote Agent

REMOTE115_CM_SHELL_TYPE #Either RSH or SSH

REMOTE115_CM_CONTEXT_LOC #Location of AutoConfig file

REMOTE115_CM_FTPEXE #Either ftp or sftp

REMOTE115_CM_CPEXE #Either rcp or scp

REMOTE115_CM_SHEXE #Either rsh, remsh, or ssh

# 11i Forms Node Remote Node environment variables

REMOTE115_FRM_PATCH_TOP #Directory to download patches

REMOTE115_FRM_HOME #APPL_TOP

REMOTE115_FRM_DB_HOME #Apps Tools ORACLE_HOME

REMOTE115_FRM_NODE #Machine

REMOTE115_FRM_USER #User

REMOTE115_FRM_PLATFORM #Platform

REMOTE115_FRM_ENV_FILE #Applications environment filename

REMOTE115_FRM_CONTEXT #AutoConfig context name

REMOTE115_FRM #Remote Agent

REMOTE115_FRM_SHELL_TYPE #Either RSH or SSH

REMOTE115_FRM_CONTEXT_LOC #Location of AutoConfig file

REMOTE115_FRM_FTPEXE #Either ftp or sftp

REMOTE115_FRM_CPEXE #Either rcp or scp

REMOTE115_FRM_SHEXE #Either rsh, remsh, or ssh

# 11i Web Node Remote Node environment variables

REMOTE115_WEB_PATCH_TOP #Directory to download patches

REMOTE115_WEB_HOME #APPL_TOP

REMOTE115_WEB_NODE #Machine

REMOTE115_WEB_USER #User

REMOTE115_WEB_PASSWORD #Password

Page 86
REMOTE115_WEB_PLATFORM #Platform

REMOTE115_WEB_ENV_FILE #Applications environment filename

REMOTE115_WEB_IAS_HOME #WEB iAS Home

REMOTE115_WEB_CONTEXT #AutoConfig context name

REMOTE115_WEB #Remote Agent

REMOTE115_WEB_SHELL_TYPE #Either RSH or SSH

REMOTE115_WEB_CONTEXT_LOC #Location of AutoConfig file

REMOTE115_WEB_FTPEXE #Either ftp or sftp

REMOTE115_WEB_CPEXE #Either rcp or scp

REMOTE115_WEB_SHEXE #Either rsh, remsh, or ssh

# DB Remote Node variables for Upgrade Assistant and Maintenance Pack

Assistant products

REMOTE115_DB_VERSION #Database Version

REMOTE115_DB_ENV_FILE #Database environment filename

REMOTE115_DB_USER #User

REMOTE115_DB_HOME #RDBMS ORACLE_HOME

REMOTE115_DB_SID #Database SID name

REMOTE115_DB_PATCH_TOP #Directory to download patches

REMOTE115_DB_PORT_NUM #Database port number

REMOTE115_DB_NODE #Machine

REMOTE115_DB_PLATFORM #Platform

REMOTE115_DB_CONTEXT #AutoConfig context name

REMOTE115_DB #Remote Agent

REMOTE115_DB_SHELL_TYPE #Either RSH or SSH

REMOTE115_DB_CONTEXT_LOC #Location of AutoConfig file

REMOTE115_DB_FTPEXE #Either ftp or sftp

REMOTE115_DB_CPEXE #Either rcp or scp

REMOTE115_DB_SHEXE #Either rsh, remsh, or ssh

# DB Node variables for Database Upgrade Assistant products

Page 87
REMOTEPOST_DB_USER #User

REMOTEPOST_DB_HOME #RDBMS ORACLE_HOME

REMOTEPOST_DB_SID #Database SID name

REMOTEPOST_DB_PATCH_TOP #Directory to download patches

REMOTEPOST_DB_PORT_NUM #Database port number

REMOTEPOST_DB_LISTENER #Database listener name

REMOTEPOST_DB_NODE #Machine

REMOTEPOST_DB_PLATFORM #Platform

REMOTEPOST_DB_ENV_FILE #Database environment file

REMOTEPOST_DB_CONTEXT #AutoConfig context name

REMOTEPOST_DB_SHELL_TYPE #SSH or RSH

REMOTEPOST_DB #Remote agent

REMOTEPOST_DB_SHEXE #rsh, remsh, or ssh

REMOTEPOST_DB_FTPEXE #ftp or sftp

REMOTEPOST_DB_CPEXE #rcp or scp

REMOTEPRE_DB_CONTEXT #AutoConfig context name

REMOTEPRE_DB_ENV_FILE #Database environment file

REMOTEPRE_DB_USER #User

REMOTEPRE_DB_HOME #RDBMS ORACLE_HOME

REMOTEPRE_DB_SID #Database SID name

REMOTEPRE_DB_PORT_NUM #Database port number

REMOTEPRE_DB_LISTENER #Database listener name

REMOTEPRE_DB_NODE #Machine

REMOTEPRE_DB_PLATFORM #Platform

REMOTEPRE_DB_SHELL_TYPE #RSH or SSH

REMOTEPRE_DB #Remote agent

REMOTEPRE_DB_SHELL_EXE #rsh, remsh, or ssh

REMOTEPRE_DB_SHEXE #rsh, remsh, or ssh

REMOTEPRE_DB_FTPEXE #ftp or sftp

Page 88
REMOTEPRE_DB_CPEXE #rcp or scp

# 12 Admin Node Remote Node environment variables

REMOTE12_APP #Remote Agent

REMOTE12_APP_CONTEXT #AutoConfig context name

REMOTE12_APP_CPEXE #rcp or scp

REMOTE12_APP_DB_HOME #Apps Tools ORACLE_HOME

REMOTE12_APP_FTPEXE #ftp or sftp

REMOTE12_APP_HOME #APPL_TOP

REMOTE12_APP_NODE #Machine

REMOTE12_APP_PATCH_TOP #Directory to download patches

REMOTE12_APP_PLATFORM #Platform

REMOTE12_APP_SHELL_TYPE #SSH or RSH

REMOTE12_APP_SHEXE #rsh or ssh

REMOTE12_APP_USER #User

REMOTE12_APP_ENV_FILE #Applications environment file

REMOTE12_APP_CONTEXT_LOC #Location of AutoConfig file

# 12 Concurrent Manager Node Remote Node environment variables

REMOTE12_CM #Remote agent

REMOTE12_CM_CONTEXT #AutoConfig context name

REMOTE12_CM_CPEXE #rcp or scp

REMOTE12_CM_DB_HOME #Apps Tools ORACLE_HOME

REMOTE12_CM_FTPEXE #ftp or sftp

REMOTE12_CM_HOME #CM_HOME

REMOTE12_CM_NODE #Machine

REMOTE12_CM_PATCH_TOP #Directory to download patches

REMOTE12_CM_PLATFORM #Platform

REMOTE12_CM_SHELL_TYPE #SSH or RSH

REMOTE12_CM_SHEXE #rsh or ssh

REMOTE12_CM_USER #User

Page 89
REMOTE12_CM_ENV_FILE #Applications environment file

REMOTE12_CM_CONTEXT_LOC #Location of AutoConfig file

# 12 Forms Node Remote Node environment variables

REMOTE12_FRM # Remote agent

REMOTE12_FRM_CONTEXT #AutoConfig context name

REMOTE12_FRM_CPEXE #rcp or scp

REMOTE12_FRM_DB_HOME #Apps Tools ORACLE_HOME

REMOTE12_FRM_FTPEXE # ftp or sftp

REMOTE12_FRM_HOME #APPL_TOP

REMOTE12_FRM_NODE #Machine

REMOTE12_FRM_PATCH_TOP #Directory to download patches

REMOTE12_FRM_PLATFORM #Platform

REMOTE12_FRM_SHELL_TYPE #SSH or RSH

REMOTE12_FRM_SHEXE #rsh or ssh

REMOTE12_FRM_USER #User

REMOTE12_FRM_ENV_FILE #Applications environment file

REMOTE12_FRM_CONTEXT_LOC #Location of AutoConfig file

# 12 Web Node Remote Node environment variables

REMOTE12_WEB #Remote agent

REMOTE12_WEB_CONTEXT #AutoConfig context name

REMOTE12_WEB_CPEXE #rcp or scp

REMOTE12_WEB_FTPEXE #ftp or sftp

REMOTE12_WEB_HOME #APPL_TOP

REMOTE12_WEB_IAS_HOME #WEB iAS Home

REMOTE12_WEB_NODE #Machine

REMOTE12_WEB_PATCH_TOP #Directory to download patches

REMOTE12_WEB_PLATFORM #Platform

REMOTE12_WEB_SHELL_TYPE #SSH or RSH

REMOTE12_WEB_SHEXE #rsh or ssh

Page 90
REMOTE12_WEB_USER #User

REMOTE12_WEB_ENV_FILE #Applications environment file

REMOTE12_WEB_CONTEXT_LOC #Location of AutoConfig file

# Pre-upgrade variables for 10.7 Administration nodes

REMOTE_APP_PATCH_TOP #Directory to download patches

REMOTE_APP_HOME #APPL_TOP

REMOTE_APP_DB_HOME #Applications Tools ORACLE_HOME

REMOTE_APP_NODE #Machine

REMOTE_APP_USER #User

REMOTE_APP_PLATFORM #Platform

REMOTE_APP_ENV_FILE #Applications environment filename

REMOTE_APP_SHELL_TYPE #SSH or RSH

REMOTE_APP #Remote Agent

REMOTE_APP_SHEXE #rsh, remsh or ssh

REMOTE_APP_FTPEXE #ftp or sftp

REMOTE_APP_CPEXE #rcp or scp

# Pre-upgrade variables for 10.7 Forms nodes

REMOTE_FRM_PATCH_TOP #Directory to download patches

REMOTE_FRM_HOME #APPL_TOP

REMOTE_FRM_DB_HOME #Applications Tools ORACLE_HOME

REMOTE_FRM_NODE #Machine

REMOTE_FRM_USER #User

REMOTE_FRM_PLATFORM #Platform

REMOTE_FRM_ENV_FILE #Applications environment filename

REMOTE_FRM_SHELL_TYPE #SSH or RSH

REMOTE_FRM #Remote Agent

REMOTE_FRM_SHEXE #rsh, remsh or ssh

REMOTE_FRM_FTPEXE #ftp or sftp

REMOTE_FRM_CPEXE #rcp or scp

Page 91
REMOTE_FRM_ORAWEB_HOME #OWS $ORAWEB_HOME path

REMOTE_FRM_ORAWEB_SITE #OWS listener name

REMOTE_FRM_FORMS_PORT #Forms port

# Pre-upgrade variables for 10.7 Concurrent Manager nodes

REMOTE_CM_PATCH_TOP #Directory to download patches

REMOTE_CM_HOME #APPL_TOP

REMOTE_CM_DB_HOME #Applications Tools ORACLE_HOME

REMOTE_CM_NODE #Machine

REMOTE_CM_USER #User

REMOTE_CM_PLATFORM #Platform

REMOTE_CM_ENV_FILE #Applications environment filename

REMOTE_CM_SHELL_TYPE #SSH or RSH

REMOTE_CM #Remote Agent

REMOTE_CM_SHEXE #rsh, remsh or ssh

REMOTE_CM_FTPEXE #ftp or sftp

REMOTE_CM_CPEXE #rcp or scp

# Pre-upgrade variables for 11.03 WEB nodes

REMOTE_APP_PATCH_TOP #Directory to download patches

REMOTE_APP_HOME #APPL_TOP

REMOTE_APP_DB_HOME #Applications Tools ORACLE_HOME

REMOTE_APP_NODE #Machine

REMOTE_APP_USER #User

REMOTE_APP_PLATFORM #Platform

REMOTE_APP_ENV_FILE #Applications environment filename

REMOTE_APP_SHELL_TYPE #SSH or RSH

REMOTE_APP #Remote Agent

REMOTE_APP_SHEXE #rsh, remsh or ssh

REMOTE_APP_FTPEXE #ftp or sftp

REMOTE_APP_CPEXE #rcp or scp

Page 92
REMOTE_WEB_ORAWEB_HOME #OWS $ORAWEB_HOME path

REMOTE_WEB_ORAWEB_SITE #OWS listener name

# Pre-upgrade variables for 11.03 Forms nodes

REMOTE_APP_PATCH_TOP #Directory to download patches

REMOTE_APP_HOME #APPL_TOP

REMOTE_APP_DB_HOME #Applications Tools ORACLE_HOME

REMOTE_APP_NODE #Machine

REMOTE_APP_USER #User

REMOTE_APP_PLATFORM #Platform

REMOTE_APP_ENV_FILE #Applications environment filename

REMOTE_APP_SHELL_TYPE #SSH or RSH

REMOTE_APP #Remote Agent

REMOTE_APP_SHEXE #rsh, remsh or ssh

REMOTE_APP_FTPEXE #ftp or sftp

REMOTE_APP_CPEXE #rcp or scp

REMOTE_FRM_FORMS_PORT #forms port

# Pre-upgrade variables for 11.03 Concurrent Manager nodes

REMOTE_CM_PATCH_TOP #Directory to download patches

REMOTE_CM_HOME #APPL_TOP

REMOTE_CM_DB_HOME #Applications Tools ORACLE_HOME

REMOTE_CM_NODE #Machine

REMOTE_CM_USER #User

REMOTE_CM_PLATFORM #Platform

REMOTE_CM_ENV_FILE #Applications environment filename

REMOTE_CM_SHELL_TYPE #SSH or RSH

REMOTE_CM #Remote Agent

REMOTE_CM_SHEXE #rsh, remsh or ssh

REMOTE_CM_FTPEXE #ftp or sftp

REMOTE_CM_CPEXE #rcp or scp

Page 93
Appendix C: Examples for Using the OS Command and SQL Query Utility
Applications patching provides an example of when and how to use the OS and SQL
utilities. This appendix provides these examples as a guide to patching. For a detailed
tutorial on patching see Oracle® Applications Maintenance Utilities Release 12(Part No.
B31568-01) and Oracle® Applications Patching Procedures Release 12 (Part No.
B31567-01) from the Oracle Applications Documentation Web site.

A manager assigns each worker a unique ID and inserts a row for each worker in the
FND_INSTALL_PROCESSES table. The manager creates this table to serve as a
staging area for job information, and as a way to communicate with the worker.
Communication is accomplished using two columns: CONTROL_CODE and
STATUS.

The manager updates the table with a subset of the list of jobs, one job per worker.
For example, if there are five workers, then the table holds five jobs (even though
there may be 100 or more jobs involved in the complete action). The manager starts
the workers and uses the CONTROL_CODE and STATUS columns to assign tasks. It
polls these two columns continuously, looking for updates from the workers. As a
worker finishes their assignment, the manager updates each row with the next task in
the list, and leaves another message for the worker.

The above information can be helpful during the execution of a long patch or in
trying to diagnose a patch that has failed or is stuck.

The following are a number of useful SQL examples for the above example:

select CONTROL_CODE, STATUS

from fnd_install_processes@REMOTE

select patch_name, patch_type, creation_date

from ad_applied_patches@REMOTE

order by creation_date desc

select fa.application_short_name, fpi.STATUS, fpi.PATCH_LEVEL

from fnd_product_installations@REMOTE fpi, fnd_application@REMOTE fa

where fpi.application_id = fa.application_id

order by 1

The deferred job feature uses the AD_DEFERRED_JOBS table. This table is created
when the FND_INSTALL_PROCESSES table is created, and is dropped when the
FND_INSTALL_PROCESSES table is dropped.

Page 94
Worker Log Files

In addition to the information recorded in the utility name.log file, utilities that
process jobs in parallel write details about errors to worker log files. The
adworknumber.log files (adwork001.log, adwork002.log, and so on) reside in the
$APPL_ TOP/admin/SID/log directory, where SID is the value of the ORACLE_SID
or TWO_TASK variable (UNIX).

Typical useful OS examples are as follows:

tail -100 $APPL_TOP/admin/$TWO_TASK/log/adwork001.log

ls –lrt $APPL_TOP/admin/$TWO_TASK/log/

tail -100 $APPL_TOP/admin/$TWO_TASK/log/adwork001.log adrelink.log

grep –i error $APPL_TOP/admin/$TWO_TASK/log/adwork001.log

$ORACLE_HOME/bin/tnsping $TWO_TASK

By default, adpatch names the log files adpatch.log but the Maintenance Wizard
standard is to have one log file for each patch and indicate that it was a patch
executed by Maintenance Wizard.

Maintenance Wizard uses the following format to names log files:

$APPL_TOP/admin/$TWO_TASK/{BugNumber_adpatch.log}

or

$APPL_TOP/admin/R12_DIAG/log/5362928_patchit12.log

Maintenance Wizard runs the patches in “non-interactive” mode. For this to work,
the defaults file must be setup in the $APPL_TOP/admin/$TWO_TASK/ directory.

The defaults file is named adalldefaults.txt by default. If it is not present,

Maintenance Wizard creates the file automatically by running autoconfig or by
running adpatch to recreate it.

For more information, see Oracle® Applications Patching Procedures Release 12 (Part No.
B31567-01) from the Oracle Applications Documentation Web site.

The following non-patching related commands may also be useful:

ps –ef | grep pmon

ps –ef |grep lsnr

tnsping $TWO_TASK

ls –l$APPL_TOP/admin

Page 95