adpatch

Executes the adpatch command line interface to perform 12.1.3 EBS patches.  

Environment/Instance Properties

Property NameProperty CodeRequiredDescription
EBS Source Script
FDEBS_SOURCE_SCRIPT
Yes

Source Script with full path. 
e.g. /u1/apps/apps_st/appl/APPSorcl_ebs01.env

If you would like to apply changes directly to run edition for EBS R 12.2+, specify the run param after the script. By default it connects to patch edition when performing the deploy operation. All other operations are sourced from run by default.

e.g. /u1/apps/apps_st/appl/APPSorcl_ebs01.env run

If you are adding more than one endpoint for an environment/instance, this file must be same location for all endpoints. If necessary you should create symbolic links on each endpoint, so location of environment file is same.
EBS Database Password
FDEBS_DB_PASSWORD
YesPassword to connect for EBS Database User.
EBS System Password
FDEBS_SYSTEM_PASSWORD
YesSYSTEM Password for running adpatch.
EBS Database SID
FDEBS_DB_SID
YesDatabase SID for the EBS install.

Inputs

Input NameInput CodeRequiredDescription
Patch Top
FDEBS_INP_PATCH_TOP
YesPatch top to be used when applying a patch via adpatch.  This should be the parent folder of the driver file.
Driver Name
FDEBS_INP_DRIVER_NAME
YesThe driver to execute as part of the patch.  This must only be the driver file, specifying a relative path to the driver will not work.  
Number of Workers
FDEBS_INP_NUM_WORKERS
YesThe number of workers to use when applying the patch.  The default is 8 but it should be configured based on the number of servers in your cluster.
Abandon Session
FDEBS_INP_ABANDON_SESSION
NoIf the previous session failed or was interrupted should this execution resume where the previously halted session stopped?
Test Mode
FDEBS_INP_TEST_MODE
NoSetting this to true will only output the steps that would be applied if applying the patch outside of Test Mode.  You can run this first to verify the patch steps.  When running in test mode it is recommended to run in Hot Patch as well.
Hot Patch
FDEBS_INP_HOT_PATCH
NoSetting this to true will result in a hot patch being applied.  When hot patching, the EBS server will not be put in maintenance mode.
EBS Patch Notification
FDEBS_INP_PATCH_NOTIFICATION
NoShould a notification email be sent on failure?
EBS Patch Notification Email
FDEBS_INP_PATCH_NOTIFICATION_EMAIL
NoEmail to use in the case of FDEBS_INP_PATCH_NOTIFICATION being true.
Defaults Override
FDEBS_INP_ADPATCH_DEFAULTS_FILE
NoThis plugin makes use of a defaults file to provide silent input to the adpatch command.  If you wish to use your own defaults file to apply the patch you can specify that here.

Artifacts

This operation doesn’t consume or produce any artifacts.

Endpoint Selection

This operation will select all available endpoints associated to the environment instance which have resource type of EBS Web Server

Endpoint Execution

This operation will execute on any one of the selected endpoints and will be random in the determination of which one.

Special Considerations

Running in HotPatch and TestMode

Before applying a patch it is recommended to run with HotPatch and TestMode enabled.  This behavior will test the patch application whilst not putting the server in maintenance mode.


Our Defaults File

This operation makes use of a defaults file to pass parameters to the adpatch command.  This file is only here for reference if you wish to specify your own defaults file via the FDEBS_INP_ADPATCH_DEFAULTS_FILE input.  All defaults files will have FlexDeploy property replacement performed on them.

Defaults File
## Start of Defaults Record
  %%START_OF_TOKEN%%
        MATCH_APPL_TOP
  %%END_OF_TOKEN%%

  %%START_OF_VALUE%%
        Yes
  %%END_OF_VALUE%%
## End of Defaults Record

## Start of Defaults Record
  %%START_OF_TOKEN%%
        LOG_FNAME
  %%END_OF_TOKEN%%

  %%START_OF_VALUE%%
        adpatch.log
  %%END_OF_VALUE%%
## End of Defaults Record

## Start of Defaults Record
  %%START_OF_TOKEN%%
        DEF_ACTIVATE_EMAIL
  %%END_OF_TOKEN%%

  %%START_OF_VALUE%%
        ${{FDEBS_INP_PATCH_NOTIFICATION}}
  %%END_OF_VALUE%%
## End of Defaults Record

## Start of Defaults Record
  %%START_OF_TOKEN%%
        DEF_EMAIL_LIST
  %%END_OF_TOKEN%%

  %%START_OF_VALUE%%
        ${{FDEBS_INP_PATCH_NOTIFICATION_EMAIL}}
  %%END_OF_VALUE%%
## End of Defaults Record

## Start of Defaults Record
  %%START_OF_TOKEN%%
        DEF_BATCH_SIZE
  %%END_OF_TOKEN%%

  %%START_OF_VALUE%%
        1000
  %%END_OF_VALUE%%
## End of Defaults Record

## Start of Defaults Record
  %%START_OF_TOKEN%%
        CORRECT_DBENV
  %%END_OF_TOKEN%%

  %%START_OF_VALUE%%
        Yes
  %%END_OF_VALUE%%
## End of Defaults Record

## Start of Defaults Record
  %%START_OF_TOKEN%%
        DEF_SYSTEM_PWD
  %%END_OF_TOKEN%%

  %%START_OF_VALUE%%
        ${{FDEBS_SYSTEM_PASSWORD}}
  %%END_OF_VALUE%%
## End of Defaults Record

## Start of Defaults Record
  %%START_OF_TOKEN%%
        ORACLE_username_Application_Object_Library
  %%END_OF_TOKEN%%

  %%START_OF_VALUE%%
        APPLSYS
  %%END_OF_VALUE%%
## End of Defaults Record

## Start of Defaults Record
  %%START_OF_TOKEN%%
        ORACLE_password_Application_Object_Library
  %%END_OF_TOKEN%%

  %%START_OF_VALUE%%
        ${{FDEBS_DB_PASSWORD}}
  %%END_OF_VALUE%%
## End of Defaults Record