Patch Manager

Introduction

Patch Manager allows you to deploy patches across Oracle E-Business Suite instances from a single console. You can create a patch run definition and run it multiple times on multiple instances and you can copy a patch procedure and modify it to suit your business needs. Also, you can easily access details on patch runs, correct errors if necessary, and continue the patch runs.

Key Features

Patch Manager

With Patch Manager, you can

Diagnostic Tests for Patch Manager

You should run diagnostic tests on your system in preparation for running Patch Manager procedures to ensure your system is set up correctly. These tests can be accessed from the Diagnostics dashboard, available from the Pack Diagnostics link on the Oracle Applications page. For more information on running diagnostic tests, see: Running Pack Diagnostics Tests.

The following tables list tests related to Patch Manager:

Generic Diagnostic Tests for Patch Manager
Step Test Group Description Notes/Expected Results/Corrective Measures
EMGC Check permissions for OMS Stage directory Determine if a stage directory is defined on the OMS. Determine if the owner of has read/write permissions to that directory. Expected results are: the OMS Stage Directory Location, with the OMS user with read/write permissions.
EMGC Check Patch Manager Stage directories Verify if the properties set in the Preferences page have proper definitions for Patch Manager Stage directories Refer to Running a Patching Procedure for instructions on completing this step.
EMGC Summary A summary of all of the diagnostic tests that have been executed, in the following groups: Successful, Failed, With Warning, Aborted, and Total.
EBS Check if EBS Snapshot in OMS Repository is valid Verify if the Oracle E-Business Suite snapshot in OMS Repository is valid. A snapshot shows data about a system for a point in time. If the snapshot is invalid, navigate to Targets > Oracle Applications > <target system name>. Expand "Application Nodes". For each node, click on the Report icon and click the Refresh button on the View Configuration page.
EBS Check for EBS CPU Count Verify that the target Oracle E-Business Suite system's CPU Count is greater than zero (0). If there is not a valid snapshot, contact Oracle Support.
EBS Summary A summary of all of the diagnostic tests that have been executed, in the following groups: Successful, Failed, With Warning, Aborted, and Total.
User-Specific Diagnostic Tests for Patch Manager
Step Test Group Description Notes/Expected Results/Corrective Measures
EMGC CheckMetalinkCredentials Verify if username/password credentials are entered for My Oracle Support. Refer to the Oracle Enterprise Manager documentation for instructions on completing this step.
EMGC CheckPrivilege Check if the user currently logged in has authority to patch any instances.
EMGC Summary A summary of all of the diagnostic tests that have been executed, in the following groups: Successful, Failed, With Warning, Aborted, and Total.
EBS Check if Preferred Credentials exist Check if if the EM User has the required Preferred Credential set for APPS and SYSTEM schema users in "Oracle E-Business Suite" target type. Check if that user has the required Preferred Credentials for "Oracle E-Business Suite Infrastructure" target type for Database Context and for APPL_TOP Context.
EBS Summary A summary of all of the diagnostic tests that have been executed, in the following groups: Successful, Failed, With Warning, Aborted, and Total.

Patch Manager Home

the picture is described in the document text

The Patch Manager Home tab lists your patch runs according to their status: Completed, Scheduled, Saved, Pending Approval, Approved, and Rejected.

You can click on a Patch Run name to view its details. See: View a Patch Run.

To start a new patch run, you can select "Patch Oracle E-Business Suite" or your customized patching procedure from the "Start a Patch" list.

To copy an existing patch run, in order to change any aspect of the patch run or to run an identical run due to changes in the patch or target, select the Patch Run you wish to copy and click the Create Like [Status] button (for example, the Create Like Completed button).

To view the details of an existing patch run, select the patch run in the Patch Manager Home tab and click the Review [Status] button (for example, the Review Completed button).

Patching Procedures

the picture is described in the document text

The Patch Manager Procedures tab lists the available patching procedures. You cannot edit procedures created by Oracle, but you can copy them using the Create Like feature (accessed from Procedures Tab by clicking on the name of the procedure and then choosing Create Like), and then customize the copies to fit your environment.

To run a patching procedure, select the procedure from the table and click Run.

During the patching Deployment Procedure the system will try to "black out" the targets associated with an Oracle E-Business Suite system. In order for the blackout to occur, the user submitting the patch run must have been granted the 'operator' or 'blackout target' target privilege for the Oracle E-Business Suite targets. Below is a list of Oracle E-Business Suite targets that will be blacked out if the system detects this user has the authority to black them out:

By default, the blackout time period is one hour. You can control the blackout duration setting the following properties in the Preferences page: Navigate to this page from the Preferences link under Related Links on the Oracle E-Business Suite home page.

In addition, as part of a queueing mechanism for patch runs, set the property Minutes Patch Manager should wait for a down target. If a patch run is executing and detects that a target(s) that it is supposed to patch is in a blackout state, the patch run will wait this specified time before failing. Patch Manager will check every minute to see if the target has come out of the blackout state; if it has, Patch Manager will continue with the patch run.

Finally, if you want AutoPatch to apply a patch regardless of whether the Oracle E-Business Suite system is in Maintenance Mode (and Maintenance Mode is enabled), then check the Default Hotpatch in Patch Manager box.

Searching for a Patch Run

the picture is described in the document text

Use the Search Patch Runs tab to search for particular patch runs.

The search criteria are:

Patch runs that meet the search criteria are shown in the search table. Click on the patch run name link to view details of the patch run.

Running a Patching Procedure

Oracle provides you with patching procedures that are best practices for patching Oracle E-Business Suite. Procedures created by Oracle cannot be edited, but they can be copied using the "Create Like" feature so that you can customize the procedure to fit your environment.

To run a patching procedure, or create a patch run, you can do one of the following:

Note that you can also copy an existing patch run. From the Home tab, select the patch run you wish to copy and click the Create Like [Status] button.

Note: In the Patch Run interview you can use the Back button to go back to a previous step; however, entered values on the current page will be lost.

The following are prerequisites to running a patching procedure:

  1. To download an Oracle patch directly from My Oracle Support, the following property must be set in the Preferences page.

    • Connect to My Oracle Support for Patches - This box should be checked.

  2. Patches are downloaded to the OMS when they are applied. Set the property OMS Stage Directory Location to the directory to which the patch should be downloaded.

    Note: If a patch has already been downloaded to the OMS, it will not be downloaded again.

    After a patch is on the OMS, it will then be moved to the target Oracle E-Business Suite system. The exception to this step is the case in which the system detects that an Oracle patch is already on the target; the system will not move the patch from the OMS to the target again. Custom patches, described in the next chapter, will always be moved from the OMS to the target because a developer can change the patch.

  3. You should specify the following directory locations in the Preferences page. Navigate to this page from the Preferences link under Related Links on the Oracle E-Business Suite home page.

    • Target Stage Directory Location - The directory to which zipped patches are downloaded.

    • Target Patch Directory Location - The directory to which patches are unzipped and from where the patches are applied.

  4. As part of a queueing mechanism for patch runs, set the property Minutes Patch Manager should wait for a down target.

    If a patch run is executing and detects that a target(s) that it is supposed to patch is in a blackout state, the patch run will wait this specified time before failing. Patch Manager will check every minute to see if the target has come out of the blackout state; if it has, Patch Manager will continue with the patch run. This property specifies in minutes the maximum length of time Patch Manager will wait before the patch run fails.

  5. Patch Manager uses Preferred Credentials. These must be set prior to running a patch procedure. The Preferred Credentials that might be required are:

    • For the host, the application node and database credentials.

    • For the database schema, the APPS schema and system schema credentials.

To create a Patch Run

  1. On the Patch Run Details page, enter the details below.

    the picture is described in the document text

    • Patch Run Name - Enter a user-friendly name for the patch run. You can search on this name later on.

    • Description

    • Justification

    • Requester - The default value is the user name with which you are signed in. You can change this to another name.

  2. On the Target List page, enter the target system(s) to which the patch(es) will be applied.

    the picture is described in the document text

    To search for available targets, click the Add button under "Applications Systems". The List of Values (LOV) window displays the target names and their release levels. Select the desired targets from this window. Note: All targets selected must be at the same release level.

    Once selected, the system name will appear in the Target List with the following:

    • Applications System Name - The name of the system.

    • Status - The status of the system (Up or Down).

    • Applications Release - The release level of the applications system.

    • Workers - The number of workers available on the system. Note that you can change this value.

    • Database Version - The release level of the database for the applications system.

    • Languages - The languages installed on this system. Note: Newly installed languages may not show up yet if collections haven’t run.

    • Select Patch Nodes - Choose which nodes adpatch will run on.

      Note: Patch Manager allows you to choose these nodes if you have a multi-node system with a shared APPL_TOP or a multi-node system with a non-shared APPL_TOP.

    • Remove - Click this icon to remove this applications system from the Target List.

    You can click the Remove All button to remove all applications systems from the Target List.

    Click the Test Credentials button to test the Preferred Credentials for the applications system.

  3. In the Patch Details page, select the details for the patch(es) to be applied.

    the picture is described in the document text

    The following are shown on the Patch Details page: These are set in the Preferences page.

    • Target Stage Directory Location - The directory to which zipped patches are downloaded.

    • Target Patch Directory Location - The directory to which patches are unzipped, and from where the patches are applied.

    • OMS Stage Directory Location

    Important: You must have at least 'view' target privilege on the agent(s) of the target hosts. For example, say you are patching an Oracle E-Business Suite system that contains 3 middle tiers. You must have the 'view' privilege (or greater) on the agents of these 3 middle tiers.

    Enter the Software Updates you wish to apply. Use the Add Oracle Patch to add a patch from Oracle, and use Add Custom Patch to add a custom patch created through Customization Manager.

    Important: Before you deploy a custom patch in Patch Manager, you should run the Instance Comparison Report to compare the technology stack properties of the package with those of the instance to which the package is being deployed. Patch Manager does not stop the deployment of a patch if the technology stack properties are not compatible, so you should make your best judgement based on the Instance Comparison Reports.

    To add an Oracle patch:

    1. Select Add Oracle Patch.

    2. In the Search and Select window, Patch Oracle E-Business Suite, if you are downloading a patch or patches from My Oracle Support, you can search based on the following criteria:

      • Patch Number

      • Platform - "Any" returns patches for all platforms, or Generic if patch is not port-specific.

        If you are searching for a patch for a specific platform, your search results will return a Generic-platform patch if no platform-specific patch exists.

      • Language - "All installed languages" will return the base (Generic or platform-specific) patch plus any language patches (if they exist) for every language installed on the selected targets. Choosing a specific language from the drop-down list will return its language patch if it exists plus the base patch.

      You can also select Simple Search to search simply on the Patch Number.

      The search results will include the following for each patch found:

      • Patch Number

      • Platform

      • Version

      • Language

      • Description

      • Included or Replaced By

      If you plan to deploy patches from an OMS location, the Search window will provide a List of Values based on the patches located in the directory specified for OMS Stage Directory Location in the Preferences page.

      Choose the desired patches and click Select to return to main window.

    Note: You must retrieve the desired patch through the Search and Select: Add Oracle Patch window even if you have already downloaded the patch to the stage location (the process will not re-download the patch, however).

    To add a custom patch:

    1. Select Add Custom Patch.

    2. In the Search and Select window, you can search based on the following criteria:

      • Patch Number

      • Patch Name

      • Description

      • Created By

      • Version

      • Language

      The search results will include the following for each patch found:

      • Patch Number

      • Patch Name

      • Version

      • Language

      • Description

      • Created By

      Choose the desired patches and click Select to return to main window. A listing of patches is given.

    A Merge Patches check box appears at the top of the table if more than one patch has been selected.

    Note: You should merge AD patches separately from non-AD patches.

    The following appears for each patch in the table.

    • Patch ID - The patch number.

    • Product - The short name of the owning product.

    • Platform - The platform for the patch.

    • Version - The version to which the patch is valid.

    • Description - The description of the patch.

    • Files - The files to be downloaded for the patch.

    • Password - A password is necessary for downloading controlled-release patches. Passwords expire after 21 days, so for scheduled deployments further in the future make sure you have already downloaded the patch and staged it.

    • Order - The order the patches should be applied. Will only be displayed when you have more then one patch selected and don’t have merge patches check box checked.

    • Can Be Re-applied - You can check this box if the patch can be re-applied with no ill effects. In the case of testing, it might be necessary to apply the same patch repeatedly, in which case this box should be checked.

    • Pause After Patching - Check this box if you will need to perform post-patching steps (such as running a script) immediately after this patch is applied. This option does not appear when the Merge Patches check box is checked.

      Note that this option causes the Deployment Procedure job to halt with the status of "Failure" so that the job is paused for post-patching steps. Once you have performed your required tasks, select the Retry button within the EM Console.

    • README - Click on this icon to review the README file for the patch.

    • Techstack Report - Only applicable to custom patches. This report is described in the section on Instance Comparison Reports in Creating a Report.

    • Remove - If you want to remove this patch from the list, click this icon.

    Finally, you can check for prerequisites for your patches using the Check Prerequisites button.

  4. Specify Patch Options.

    the picture is described in the document text

    Specify details for how the patch should be applied.

    For more information on many of these options, see: Oracle E-Business Suite Patching Procedures and Oracle E-Business Suite Maintenance Utilities.

    Patching Procedure Options include the following:

    • Create Target Backup Before Patching - Adds a pause after system is prepared for backup allowing for a manual backup.

    • Create Target Backup After Patching - Adds a pause after patch is applied and database is brought back down to allow for a manual backup.

    • Enable HotPatch Mode - Patch will be applied without shutting down the applications or database, disabling archive mode, or enabling maintenance mode.

      In HotPatch mode, AutoPatch applies a patch regardless of whether the Oracle E-Business Suite system is in maintenance mode. Maintenance mode controls the system downtime period by managing user login sessions.

      Note: In HotPatch mode, if the patch application fails, the process will still perform/execute the blackout steps in the "Patch Oracle E-Business Suite" procedure. The blackout notifies other Enterprise Manager administrators that a maintenance procedure is being performed on the environment.

    • Disable Archive Mode - Issues an 'alter database noarchivelog' command.

    • Pause Before AutoPatch Steps - Adds a pause before AutoPatch (adpatch) is run to allow for any necessary manual preparation.

      AutoPatch (adpatch) is the Oracle Applications DBA (AD) tool that applies patches to an Oracle E-Business Suite system.

    • Pause After AutoPatch Steps - Adds a pause immediately after patch is applied to allow for any necessary manual activities.

      Note: This option is not the same as the "Pause After Patching" option in the Patch Details page (Step 3). The "Pause after Patching" step, performed at the individual patch level, causes the Deployment Procedure job to halt so that manual steps can be done immediately after that patch is applied. The "Pause After AutoPatch Steps" option introduces a manual step into the Deployment Procedure which causes the Deployment Procedure to pause. This manual step can be used to do manual work or it can be modified in a custom procedure to run an automated script.

    • Run AutoConfig - Run AutoConfig, the AD tool that manages configuration changes in an Oracle E-Business Suite system.

    • Pause After AutoConfig Test Mode Step - Adds a pause after AutoConfig is run in test mode to allow for validation of changes.

    AutoPatch Options include the following:

    • Enable Prerequisite Patch Checking - Prevents you from applying a patch without first applying all required prerequisite patches.

    • Disable JSP Compilation - Tells adpatch not to automatically compile out-of-date JSP files (nocompilejsp command).

    • Disable Invalid Objects Compilation - Tells adpatch not to compile invalid objects (nocompiledb command).

    • Enable Schema Validation - Tells adpatch to connect to all registered Oracle E-Business Suite schemas at the start of the patching process.

    • Disable File Generation - Tells adpatch not to run commands normally found in generate driver (nogenerateportion command).

    AD Administration Options are listed below. These tasks are done to manage database objects (database objects or data in the database related to Oracle E-Business Suite). For example, a patch might add new menu entries or change the setup of a flexfield.

    • Generate Message Files - Creates new message files after the messages have been loaded into the database. The README should instruct you when this is necessary.

    • Compile APPS Schema - Compiles the APPS schema.

    • Compile Menu Information - Compiles menus.

    • Compile Flexfields - Compiles flexfields.

    • Recreate Grants and Synonyms for APPS Schema - Recreates grants and synonyms for the APPS schema.

    • Relink Application Programs

    • Generate Product JAR Files

    • Generate Reports Files

    • Generate Form Files

  5. Specify the Schedule for the patch application.

    the picture is described in the document text

    You can choose to apply the patches immediately or at a later date.

    If you choose Immediately as the schedule type to have the patches applied immediately.

    If you choose Later, you can specify the time and date you wish to have the patches applied. Provide the Time Zone, Date and Time.

    You can specify a Grace Period as well. If you choose an Indefinite Grace Period, then if for some reason the patches cannot be applied at the immediate time, the system will try to apply them as soon as possible, and will keep trying indefinitely. If you provide a defined Grace Period by specifying the system to end the Grace Period after your given hours and minutes, the system will not try to apply the patches after that amount of time.

    The Blackout Length indicates the amount of time the target system will have a blackout status in Enterprise Manager. Set this length to a higher value for large patch runs.

  6. Review your patch run.

    the picture is described in the document text

    The Review Page lets you review your patch run details, target list, patch details, patching options, credentials, and schedule.

Copying a Patch Run

You might want to copy an existing patch run to change some aspect of it or to rerun it due to changes in the patch or target. To do this, select the patch run in the Patch Manager Home tab and click the Create Like [Status] button.

the picture is described in the document text

The system will take you through the patch run creation pages as if you were creating a new patch run, but with most values copied from the original patch run. Please note the following:

Viewing a Patch Run

To view the user-entered details of a patch run, select the patch run in the Patch Manager Home tab and click the Review [Status] button.

You can navigate to the details of the deployment of a patch run in one of several ways:

The above navigation paths take you to the Status page for the procedure. The Status page is part of the Oracle Deployment Manager. Refer to the Oracle Enterprise Manager online help for more information on Oracle Deployment Manager.

Information on this Status page includes when the patch run was started and completed and each step in the procedure and its status. You can also drill down in each step to view logging information, errors, and so on.

Extending Patch Manager Deployment

You can extend Patch Manager procedures using the Deployment Procedure Manager using the steps below. In these steps you create a copy of an existing procedure and extend it in the Deployment Procedure Manager.

  1. From the Patch Manager Procedures tab, click on the name of a procedure.

  2. From the View Procedure page, click the Create Like button.

  3. Rename the copy of the original procedure as desired. You can make other updates here as well.

  4. Save your new procedure.

  5. Upon saving, the Deployment Procedure Manager Procedures tab appears. Your new procedure is listed first. You can select this procedure and click Edit to add steps, choose notifications, or make other changes. For example, you might want to add steps to a copy of the shipped Patch Oracle E-Business Suite procedure to automate the following steps: Pre-Patch Application Tier Backup, Post-Patch Database Tier Backup, or Post-Patch Application Tier Backup.

For more information on the Deployment Procedure Manager and provisioning in Enterprise Manager, refer to the Enterprise Manager documentation, including:

Logging, Health Checks, and Troubleshooting

This section describes logging, health checks, and troubleshooting features within Patch Manager.

How to View the AD Patch Log

To view the AD Patch Log for a patch run, follow these steps:

  1. Navigate to your patch run using any method in "View a Patch Run".

  2. Click on the Patch Run Name.

  3. Click on the adpatch step (Apply Patch).

  4. Click on Job Status.

  5. Expand the bottom task.

  6. Click on Step: Execute command as normal user.

How to Restart Failed Workers

  1. Navigate to your patch run using any method in "View a Patch Run".

  2. Click on the Patch Run Name.

  3. Click on the adpatch step (Apply Patch).

  4. Select the check box for the failed target.

  5. Click Update and Retry.

  6. Change the parameter "restart_workers" to YES and click Retry.

Note: These steps are also listed in the AD Patch Log when you have a failed worker.

Troubleshooting Patch Manager Deployment Failures

  1. Navigate to your patch run using any method in Viewing a Patch Run.

  2. Click on the Patch Run Name.

    The Deployment Procedure Manager in Provisioning appears.

  3. For the patch run that failed, click on the links for Status and Job Status for the step that failed. Information on the failure including the output log listing errors encountered is shown.

Health Checks

Patch Manager validates these servers shutting down and starting up: listener, Forms server, Apache web services, and Internal Concurrent Manager.