Upgrade Orchestrator provides the following features:
Upgrade Orchestrator is run on all host types except for the DB host. The upgrade is performed in phases, during which sets of tasks run. Upgrade Orchestrator waits to ensure that the current set of tasks run to successful completion on all hosts before proceeding to the next set of tasks. If there is a participating host which is not reporting its status, an email alert is sent with corrective action. The frequency of email alerts can be modified by the EMAIL_LEVEL property. For more information, see Table 11-1.
Upgrade Orchestrator pauses when it reaches a task that must be performed outside of orchestration. Perform the required steps and then direct Upgrade Orchestrator to continue with the upgrade. If multiple environments are sharing the orchestration software location, a pause point that is created on a host type is common across all environments for that host type.
Default pause points are predefined by Upgrade Orchestrator to allow you to perform the following actions:
Perform required backups
Upgrade the Oracle Identity Management domain
Start external servers
Default pause points cannot be edited or removed. For more information, see Pause Point Steps.
The Oracle Fusion Applications Orchestration report is generated for each pod and its location is defined in the mandatory ORCH_REPORT_LOCATION
property in the pod.properties
file. When running the report, it is possible to override the default value for the location, if needed. In the event of a failure during the upgrade, this report is generated and emailed to the users who are specified in the EMAIL_TO_RECIPIENT
and EMAIL_CC_RECIPIENT
properties, if the EMAIL_LEVEL
property is set to do so. The report name is FAOrchestrationReport_
release
_
hosttype
_
hostname
_
timestamp
.html
. Reports are archived at ORCH_LOCATION
/ARCHIVE/
release
/
hosttype
/
hostname
/
timestamp
for troubleshooting purposes after the failure or completion of each task.
The report displays the task that failed, including the phase and host type. The Fusion Applications Orchestration report also displays the following information:
Upgrade from Release: The starting release on the pod, which could be release 11.1.8.0.0 or 11.1.9.n.n.
Upgrade to Release: The ending release, which in this case is "FA version 11.12.x.0.0".
Upgrade Status: The cumulative status of the upgrade. The following states are possible:
Success: All tasks were successful.
Error: One or more tasks failed.
Running: At least one task is still running and there are no failures.
NotApplicable: The task is not applicable on the host.
Pending: A task is waiting for a dependent task to complete.
PausePoint: A task must be performed manually. Orchestrator needs to be restarted after the manual process completion.
Report Time: The time stamp in the format of yyyy-MM-dd HH:mm:ss.SSS.
Status Table: Contains the following columns:
Task: Tasks are listed in the order of execution.
Phase: Phase during which the task runs.
Host type: Host type on which the task runs.
HostNames: All scaled out hosts for the host type.
Status: Status of the task for each host, including scaled out hosts.
Start Time: The start time for the task on a specific host.
End Time: The end time for the task on a specific host.
Duration: The duration of the task on a specific host.
More details: The path and file name for the HTML report that is generated on each host.
If any languages in addition to US English were previously installed, Upgrade Orchestrator performs the upgrade of each installed language.
Orchestration allows skipping one or more installed language pack upgrades by using a property called SKIP_UPGRADE_FOR_LANGUAGE
in the PRIMORDIAL.properties
file. If the option of skipping any languages is chosen, upgrade them manually after the completion of Upgrade Orchestration. For more information, see Perform Optional Language Installations in the Oracle Fusion Applications Installation Guide.
This section provides additional information about Upgrade Orchestrator commands. The following topics are included:
The following command arguments are available for the orchestration command to retrieve information about the status of the upgrade as well as manage the status:
Use updateStatus
to update the status for a specific task to either SUCCESS
or FAILURE
. For more information, see Options for the Orchestration updateStatus Command.
Use getStatus
to retrieve the status of a specific task as well as the summary of the upgrade on a specific POD_NAME
and host_type
while Upgrade Orchestrator is running. For more information, see Options for the Orchestration getStatus Command and Monitor Upgrade Orchestration Progress.
Use exitOrchestration
to terminate orchestration gracefully on all hosts on a specific pod. For more information, see Terminate Upgrade Orchestration.
Use clearExitOrchestration
to clear the exit status on all hosts. For more information, see Terminate Upgrade Orchestration.
Use getExitOrchestrationStatus
to retrieve the status of the exitOrchestration
command. For more information, see Get the ExitOrchestration Status.
Use validateSetup
to validate the shared location status and permissions. This validation is implicitly run when any of the orchestration command options are run. For more information, see The validatesetup Argument.
The following table provides a description of the options available when using the orchestration command to start Upgrade Orchestrator:
Table 10-1 Options for the orchestration.sh Command
Name | Mandatory | Description |
---|---|---|
-pod |
Yes |
The value of |
-hosttype |
Yes |
The host type. Valid values are PRIMORDIAL, MIDTIER, OHS, and IDM. For more information see Host Types. |
-release |
No |
The release version, for example, 11.12.x.0.0. |
-phase |
No |
Only the |
-checkpoint |
No |
Valid values are true or false. If set to false, ignore the checkpoint results and rerun. The default value is true. |
-DlogLevel |
No |
The log level. Valid values are |
-v |
No |
Displays the product version and exits. |
-h |
No |
Displays help information and exits. |
The following table provides a description of the available options when using the orchestration updatestatus
command to update the status of orchestration tasks:
Table 10-2 Options for orchestration.sh updateStatus Command
Name | Mandatory | Description |
---|---|---|
updateStatus |
Do not use with |
Updates the status of the selected task |
-pod |
Yes |
The name of the pod to be searched |
-hosttype |
Yes |
The host type. Valid values are: PRIMORDIAL, MIDTIER, OHS, and IDM |
-hostname |
Yes |
Host name, including domain details |
-release |
Yes |
The release version, for example, 11.12.x.0.0. If this option is not used, all releases defined in the manifest file are executed |
-phase |
Yes |
The phase name. Valid values are as follows:
|
-taskid |
Yes |
Orchestration |
-taskstatus |
Yes |
Orchestration task status. Valid values are |
-v |
No |
Displays the product version and exits |
-h |
No |
Displays help information and exits |
The following table provides a description of the available options when using the orchestration getstatus
command to find the status of an orchestration session:
Table 10-3 Options for orchestration.sh getStatus Command
Name | Mandatory | Description |
---|---|---|
getStatus |
Do not use with |
Retrieves the checkpoint status from the selected orchestration task |
-pod |
Yes |
The name of the pod to be searched |
-hosttype |
Yes |
The host type. Valid values are: PRIMORDIAL, MIDTIER, OHS, and IDM |
-hostname |
Yes |
Host name, including domain details. |
-release |
Yes |
The release number, for example, 11.12.x.0.0. If this option is not used, all releases defined in the manifest file are queried |
-phase |
No |
Specify the following phase names to see the status for the specific phase:
|
-taskid |
No |
The Orchestration |
-taskstatus |
No |
The Orchestration task status. Valid values are |
-v |
No |
Displays the product version and exits |
-h |
No |
Displays help information and exits |
If the orchestration.sh
command is run with the validatesetup
argument, the following validations occur:
Validating SHARED_UPGRADE_LOCATION
Successfully validated permissions of shared folder.
Validating ORCHESTRATION_CHECKPOINT_LOCATION
Successfully validated permissions of shared folder.
Validating ORCHESTRATION_CHECKPOINT_ARCHIVE_LOCATION
Successfully validated permissions of shared folder.
These options run implicitly when any of the orchestration commands run.
This section describes the utilities that are run by Upgrade Orchestrator. This section is informational only and no action is needed. The following utilities are included:
During the installation phase, RUP Installer copies all files for Release 12 (11.12.x.0.0) to the appropriate locations, such as Oracle Fusion Middleware home and Oracle Fusion Applications Oracle home. After the file copy completes, RUP Installer calls its first installer to update Oracle Fusion Applications Patch Manager and apply Oracle Fusion Middleware patches.
When the first installer completes successfully, RUP Installer calls the second installer to perform the remaining tasks required to update and deploy artifacts to Oracle Fusion Applications. Depending on the starting release of upgrade to Release 12 (11.12.x.0.0), not all configuration assistants may run.
All mandatory configuration assistants must complete successfully before proceeding to the next configuration assistant. An autoretry
feature is introduced in Release 10 that provides the ability for certain configuration assistants to automatically retry after a failure. The following are three types of configuration assistants with respect to autoretry
:
Those that never autoretry
Those that always autoretry
Those that autoretry
, depending on how long it runs before failing. This is the default.
The following table provides a list of configuration assistants that the first installer runs. If available, links are provided to relevant troubleshooting sections.
Table 10-4 Configuration Assistants Run by Oracle Fusion Applications Release 12 (11.12.x.0.0) RUP Installer Part 1 of 2
Name | Mandatory | Description |
---|---|---|
Configure Patch Manager |
Yes |
Configures Oracle Fusion Applications Patch Manager |
Update Patch Manager and Dependent Components |
Yes |
Applies Patch Manager Patches |
Reconfigure Patch Manager |
Yes |
Reconfigures Oracle Fusion Applications Patch Manager |
Bootstrap Patch Manager |
Yes |
Updates the data model for Oracle Fusion Applications Patch Manager by running the |
Create LCM Administration Schemas |
Yes |
Creates LCM Administration schemas |
Upgrade LCM Administration Schemas |
Yes |
Upgrades LCM Administration schemas to give them the required grants |
Create Middleware Schemas |
Yes |
Creates Oracle Fusion Middleware schemas |
Apply Middleware Patch Sets |
Yes |
Applies Oracle Fusion Middleware patch sets, which can include upgrades, schema changes and installers. For more information, see Middleware Installers Invoked by the Apply Middleware Patch Sets Configuration Assistant |
Apply Pre-PSA Middleware Patches |
Yes |
Applies Pre-PSA Middleware Patches For more information, see Patches Not Supported by the Apply Pre-PSA and Post-PSA Middleware Patches Configuration Assistants |
Verify Middleware PSA Schema Credentials |
Yes |
Verifies users and logins for schemas |
Upgrade Middleware Schemas |
Yes |
Runs Oracle Fusion Middleware patch set assistants (PSA) |
Apply Post-PSA Middleware Patches |
Yes |
Applies Post-PSA Middleware Patches. For more information, see Patches Not Supported by the Apply Pre-PSA and Post-PSA Middleware Patches Configuration Assistants |
Create Grants and Synonyms on Middleware Database Objects |
Yes |
Creates |
Upgrade OPSS |
Yes |
Upgrades the Policy Store |
Apply Offline Setting and Topology Manager Changes |
Yes |
Updates Taxonomy Management tables with the information on the offerings that were selected |
Apply Offline BI Metadata and Configuration Updates |
Yes |
Performs the deployment of the updated applications policies for Oracle Business Intelligence |
Apply ESSAPP Code Source Grant Changes |
Yes |
Adds code source grants to support auditing |
Relocate Managed Servers |
Yes |
Relocates managed servers |
Configure DB Persistence Store for JMS/TLogs |
Yes |
Configures SOA and UMS to store JMS and TLogs content in the database instead of the file system |
Upgrade Offline OSN Configuration |
Yes |
|
Configure EDQ |
Yes |
Configures a new managed server for Enterprise Data Quality (EDQ) in the CommonDomain with scaled out servers in the appropriate environments. This configuration also occurs in CRM or Procurement domains if they are provisioned in the environment |
Apply Domain Configuration |
Yes |
|
Propagate Domain Configuration |
Yes |
Unzips RUP Lite for Domain Configuration into |
The following table provides a list of configuration assistants that the second installer runs. The Retry Behavior and Troubleshooting column describes what RUP Installer does after a configuration assistant fails, resolve the failure, and then resume orchestration. If available, links are provided to relevant troubleshooting sections. The second installer supports parallel processing of certain configuration assistants, which run in groups.
Table 10-5 Configuration Assistants Run by Oracle Fusion Applications Release 12 (11.12.x.0.0) RUP Installer Part 2 of 2
Name | Mandatory | Description |
---|---|---|
Configure Patch Manager |
Yes |
Configures Oracle Fusion Applications Patch Manager |
Bootstrap Patch Manager |
Yes |
Updates the data model for Oracle Fusion Applications Patch Manager by running the fapmgr |
Install Downloaded Fusion Application Patches |
Yes |
Applies Fusion Applications Patch Bundles (FAPB) in install only mode during upgrade flow |
Install Downloaded Fusion Applications Upgrade Patches |
Yes |
Installs downloaded Oracle Fusion Applications upgrade patches, as described in the Download and Unzip Mandatory Post-Release 12 Patches section |
Copy FAPB Merged Metadata |
Yes |
Copies Merged metadata from FAPB location to
ORACLE_HOME as shown in the following example:
|
Prepare Merged Metadata |
Yes |
Copies the patch metadata from the |
Offline Preverification Pre Database Content Upload |
Yes |
Performs the following validation checks while all servers are shut down:
|
Generate Data Security Policy Customization Report Pre DB upload |
Yes |
Generates a report on the data security policies with customizations before the DB content is uploaded |
Grant Privileges to Application Schemas |
Yes |
Grants system privileges to database users and creates base object privileges |
Run Fusion Applications Patchset Assistants |
Yes |
This CA is designed to be the generic place where all PSAs from FA can be invoked. Currently, only the GRC PSA is being run from here. |
Prepare Checkfile Information for Loading Database Components |
Yes |
Prepares checkfile information for loading database components |
Remove Retired SOA Composites |
No |
Remove retired SOA composites that are no longer used |
Consolidate Servers |
Yes |
Consolidates servers by reassigning resources from the source cluster to the target cluster |
Delete Application Deployments |
Yes |
Unregisters and deletes the obsolete applications including those applications that were never deployed |
Delete Managed Server Clusters |
Yes |
Deletes obsolete serves |
Load Database Components |
Yes |
Uploads the database content packaged in 11g Release 12 (11.12.x.0.0) to the database, such as database objects, seed data, and package headers and bodies |
Migrate OID User Preferences and OIM Customizations |
Yes |
Runs 2 FA supplied utility scripts to migrate the OID user preferences and the OIM customizations to the FA database |
Install Language Packs |
No |
This CA is only run if the upgraded environments have language pack already installed |
Install Downloaded Fusion Application Language Patches |
Yes |
Applies Fusion Applications Patch Bundles (FAPB) NLS patches in install only mode during the upgrade flow. This CA is applicable only if there are active languages available in the environment at the time of the upgrade |
Copy FAPB Merged Metadata for Languages |
Yes |
Copies merged metadata from FAPB location to
This CA is applicable only if there are active languages available in the environment at the time of the upgrade |
Install Downloaded Fusion Application Language Upgrade Patches |
Yes |
Installs downloaded Oracle Fusion Applications upgrade NLS patches in install only mode, as described in Download and Unzip Mandatory Post-Release 12 Patches. This CA is applicable only if there are active languages available in the environment at the time of the upgrade |
Create Language Pack Merged Metadata |
Yes |
It is invoked only when there are active languages on the pod indicated by the flag "
ACTIVE_LANG_EXISTS ". It should get invoked if the merged LP manifest file mw_patchset_manifest.xml and merged LP DB patch do not exist at the expected location. When executed it should perform the following operations:
This CA is applicable only if there are active languages available in the environment at the time of the upgrade |
Prepare Merged Metadata for Languages |
Yes |
It is invoked only when there are active languages on the pod indicated by the flag "
ACTIVE_LANG_EXISTS ". When executed, it performs the following operations:
This CA is applicable only if there are active languages available in the environment at the time of the upgrade |
Synchronize Multilingual Tables for Upgrades |
Yes |
Replicates the US seed data for each active language that is getting upgraded. It is invoked only when there are active languages on the pod indicated by the flag " |
Apply Middleware Language Upgrade Patches |
Yes |
Applies ATGPF database patches in config only mode. It is invoked only when there are active languages on the pod indicated by the flag " |
Load Database Components for Languages |
Yes |
Translates the US messages to the corresponding language messages in the database. This CA is applicable only if there are active languages available in the environment at the time of the upgrade |
Deploy BI Publisher Language Artifacts |
Yes |
Deploys BI Publisher language artifacts using catalog manager |
Update Language Release Information |
Yes |
Updates the language release version information in the AD_Languages table. This CA is applicable only if there are active languages available in the environment at the time of the upgrade |
Deploy JAZN Policies |
Yes |
Deploys updated applications policies, based on your selections during the Policy Store Analysis configuration assistant |
Tag JAZN Policies |
Yes |
Locks down all the oracle seeded policies by means of tagging and prevent the policies from being changed |
Export Roles from the Identity Store |
Yes |
Migrates the roles from the ID store to the policy store in the offline part. The online part is finished in the "Migrate Roles to Policy Store" CA |
Deploy BI Publisher Artifacts |
Yes |
Using Catalog Manager, deploys BI Publisher artifacts |
Import Oracle Data Integrator Repositories |
Yes |
|
Generate Data Security Policy Customization Report Post DB upload |
Yes |
Generates a report on the data security policies with customizations after the DB content is uploaded |
Create Grants/Synonyms on Application Database Objects |
Yes |
Creates synonyms between database objects and grants object privileges to database users |
Offline Preverification Post Database Content Upload |
Yes |
|
Configure New Managed Servers |
Yes |
Configures managed servers for new applications to be associated with the first non-admin host by default |
Update Flexfield Configuration |
Yes |
Updates the |
Deploy New Applications |
Yes |
Deploys new applications using domain extension templates |
Create AQ Queues |
Yes |
Creates AQ queues |
Populate Topology Manager Backfeed Data |
Yes |
Registers Middleware specific applications to the Topology Manager, including OSN, EDQ, and SOA applications |
Generate SOA Configuration Plan |
Yes |
Generates the configuration plan to be used for deploying SOA composites |
Register Forgot Password Page |
Yes |
Registers the HCM domain forgot password page to the OAM resource target |
Generate ADF Domain Configuration Plan |
Yes |
Generates Oracle ADF domain configuration in Metadata Service (MDS) to be used by Expression Language (EL) expressions in |
Apply Offline Setting Changes |
Yes |
Applies Oracle Fusion Applications environment configuration setting changes while all servers are shut down:
|
Quiesce SOA Servers Offline |
Yes |
Places all SOA servers in a quiescent mode, which effectively queues any incoming requests not related to the administration of the upgrade until the quiescent mode is exited |
Verify Node Manager and OPMN Status |
Yes |
Verifies the following processes:
Do not exit out of RUP Installer during this configuration assistant. |
Start All Admin Servers |
Yes |
Starts all Administration Servers |
Delete MDS Documents |
Yes |
Deletes SOA MDS artifacts |
Configure OPSS Keystore Service |
Yes |
Configures the OPSS Keystore Service |
Deploy LDIF User Data |
Yes |
Uploads the LDIF user data for the language that is being configured |
Create Fusion APPIDs |
Yes |
Creates Fusion APPID users and groups in the LDAP server and credentials for those users in the credential store |
Apply Admin Server Online Setting and Configuration Changes |
Yes |
|
Start Minimal Servers for Configuration Updates |
Yes |
Starts minimal managed servers required to run the necessary configuration assistants successfully |
Apply UCM Configuration |
Yes |
Configures UCM to store content in the database instead of the file system |
Apply WebCenter Configuration Changes |
Yes |
|
Configure VirusScan |
Yes |
|
Configure Trust Asserter |
Yes |
Configures trust asserter to be used for remote task flow Keystore Service |
Update LPA Policies |
NA |
Not applicable to on premise |
Import OWSM Repository |
No |
Imports OWSM repository to Fusion Applications database |
Configure KSS for OWSM |
Yes |
Configures Keystore Service for OWSM |
Delete Credentials |
No |
Deletes existing credentials |
Migrate Roles to Policy Store |
Yes |
Continues the role migration from the ID store to the policy store in the online part. The offline part is finished in the "Export Roles from the Identity Store" CA |
Re-Associate Security Store to Database |
Yes |
Re-associates the security store from an LDAP based security store to a database based security store |
Upgrade Admin Server Online OSN Configuration |
Yes |
Upgrades those OSN related configurations that require only the admin servers to be online |
Start All Servers |
Yes |
Starts all servers in all domains, including the BI servers. Also performs the |
Online Preverification |
Yes |
Validates the following artifacts:.
|
Deploy Data Security Grants |
Yes |
Reconciles Data Security changes |
Generate OHS Reference Configuration File |
Yes |
Generates OHS configuration files for installed product families in the directory, |
Apply OWSM Configuration |
No |
Upgrades Oracle Web Services Manager (Oracle WSM) policies after backing up the policies:
|
Deploy SPE Inline Service Artifacts |
No |
Deploys SPE Inline Service Artifacts |
Upgrade Online OSN Configuration |
Yes |
Upgrades the online OSN configuration |
Upgrade ADF Metadata |
No |
Upgrades ADF related metadata |
Apply OAM Configuration |
No |
Applies changes to the Oracle Access Manager (OAM) configuration. |
Deploy Flexfields |
No |
Deploys flexfields to the domain that hosts the |
Apply Online BI Metadata and Configuration Updates |
Yes |
Upgrades the online BI configuration |
Upgrade Custom Metadata |
No |
Upgrades custom metadata |
Import Group Space Templates |
No |
Imports changes present in group space template artifacts |
SOA Preverification |
Yes |
Performs the following steps. If there are customizations, merge them during this configuration assistant:
|
Migrate Groups to Roles in BPM Task Instances |
No |
Invokes the |
Migrate Groups to Roles in BPM Rules |
No |
Invokes the |
Apply SES Configuration Changes |
No |
Updates additional configuration updates to Oracle Secure Enterprise Search (SES) running on the Common Domain:
|
Remove UCM SES Objects |
No |
Removes the following objects on the SES search administration server:
|
Apply BPM Template Changes |
No |
Applies BPM template changes to the MDS repository |
Deploy B2B Metadata |
No |
Deploys B2B Metadata |
Deploy SOA Shared Repository |
Yes |
Deploys SOA shared repository artifacts to the SOA servers available in the environment |
Deploy Middleware SOA Composites |
No |
Deploys middleware SOA composites to every domain |
Deploy Flexfield Independent SOA Composites |
No |
Deploys SOA composites that do not depend on flexfields |
Deploy Flexfield Dependent SOA Composites |
No |
Deploys SOA composites that depend on flexfields |
Activate SOA Language |
No |
It is deployed only if the Language Pack (LP) is already installed |
Deploy Offering Dependent SOA Composites |
No |
Deploys SOA composites based on the new offering dependency |
Deploy Public Event Catalog |
Yes |
Deploys Public Event Catalog to all SOA domains |
Regenerate Customer Defined SOA Composites |
No |
NA |
Register SOA Resource Bundles |
Yes |
Deploys SOA Resource Bundles to the corresponding SOA servers |
Undeploy SOA Composites |
No |
Undeploys obsolete SOA composties and deletes their jars from disk |
Undeploy Middleware SOA Composites |
Yes |
Undeploys Middleware SOA composites |
Apply Image Routing (IPM) Artifacts |
Yes |
Applies Image Routing (IPM) artifacts |
Import Image Routing (IPM) Artifacts |
No |
Deploys IPM artifacts to the IPM server |
Apply Online Setting and Metadata Changes |
No |
|
Generate RUP Lite for OHS |
Yes |
Generates the zip file that contains all files needed by RUP Lite for OHS to upgrade OHS |
Post Configuration |
No |
Deletes wallets |
The following installers are invoked by the Apply Middleware Patch Sets configuration assistant:
Oracle Business Intelligence
Oracle Common
Oracle Data Integrator (ODI)
Oracle Database Client
Oracle Enterprise Content Management
Oracle HTTP Server (OHS) - OHS may be installed either beside the rest of the Oracle Fusion Middleware in the Oracle Fusion Applications middle tier or on a separate DMZ machine. For either case, patching OHS requires running RUP Lite for OHS.
Oracle Fusion Middleware Extensions for Applications
Oracle Global Order Promising
Oracle Identity Management (IDMUTIL)
Oracle Secure Enterprise Search (SES)
Oracle SOA Suite
Oracle Social Networking (OSN)
Oracle WebCenter Suite
Oracle WebLogic Server
Oracle Web Tier
The following patches are not supported by these configuration assistants:
Integrated Development Environment (IDE)
OHS installed in the DMZ: Installed by RUP Lite for OHS.
Database Server: Patch the Database Server. For more information, see Apply Exadata Patches for Release 12.
Oracle Identity Management Server: Patch the IDM server by following the steps in Upgrade the Oracle Identity Management Domain to Release 12 (11.12.x.0.0).
The following validation steps are performed during the SOA Preverification configuration assistant:
Business Process Management (BPM) Template
B2B Metadata: Checks if the Common Domain, SOA Managed Server, and the LDAP Server are up.
UpdateSOAMDS
SOA Composite: Verifies the taxonomy, checks if the Administration Server is up, and if the SOA platform is ready.
SOA Shared Repository: Verifies the taxonomy, checks if the Administration Server is up, and checks for SOA_SERVER and SOA_PLATFORM readiness.
SOA Resource Bundle: Verifies the taxonomy, checks if the Administration Server is up, and if the SOA platform is ready.
SOA Composites: Performs the following validation steps:
Verifies the taxonomy.
Checks if the Administration Server is up.
Checks if the SOA platform is ready.
Checks if the base composite is deployed.
Checks if the default revision is deployed.
Checks if the new revision is not deployed.
Checks whether the SOA composites that will be affected by the upgrade contain JDeveloper customizations. For more information, see Merge SOA Composite JDeveloper Customizations During SOA Preverification.
Image Routing (IPM): Checks if the IPM server is up.
Upgrade Orchestrator runs the Health Checker utility to run system checks during and after the upgrade to ensure that the environment meets recommended standards. Health Checker is run during pre-down time, as described in Run the Health Checker Utility. Health Checker is a command line utility that performs a set of validation checks against an Oracle Fusion Applications environment. The validation checks are organized into groups, based on the purpose of the checks and when the checks are performed. When Health Checker runs, it uses a specific manifest file which performs the appropriate checks. Health Checker provides a list of corrective actions for the checks that fail validation. The suggested corrective actions must be run manually to fix the issue before proceeding with the related activity, such as upgrading or patching activities.
The following topics describe the usage of Health Checker:
When running Health Checker manually, a manifest file is specified, as described in the following table. The manifest files are located in the following directories:
Before upgrading your environment, the manifest files in the following location are from the previous release. Do not use these manifest files until after the upgrade:
FA_ORACLE_HOME/lcm/hc/config
The manifest files in the following location are from the current release and must be used when running Health Checker before the upgrade:
REPOSITORY_LOCATION/installers/farup/Disk1/upgrade/config
Table 10-6 Health Checker Manifest Files
Manifest File | Host Requirements | Typical Usage of the Manifest |
---|---|---|
GeneralSystemHealthChecks.xml |
Primordial, OHS, Midtier |
Run this manifest during pre-down time and Upgrade Orchestrator runs this manifest during and after the upgrade. See General System Health Checks. |
PreDowntimeUpgradeReadinessHealthChecks.xml |
Primordial, OHS, Midtier |
Run this manifest before the upgrade downtime. See Pre-Downtime Upgrade Tasks. |
DuringDowntimeUpgradeReadinessHealthChecks.xml |
Primordial, OHS, Midtier |
Upgrade Orchestrator runs this manifest during downtime and before the upgrade starts. See Pre-Upgrade Tasks Performed by Health Checker During Downtime. |
VitalSignsChecks.xml |
Primordial |
Upgrade Orchestrator runs this manifest during the upgrade. See Vital Signs Check. |
PostUpgradeHealthChecks.xml |
Primordial, OHS, Midtier |
Upgrade Orchestrator runs this manifest after the upgrade. See Post-Upgrade Tasks Performed by Health Checker. |
LanguagePackReadinessHealthChecks.xml |
Primordial |
Run this manifest before installing a language pack. See Language Pack Readiness Health Checks. |
PostLanguagePackHealthChecks.xml |
Primordial |
Run this manifest after installing a language pack. See Post Language Pack Health Checks. |
PatchingReadinessHealthChecks.xml |
Primordial |
Run this manifest before applying a patch. See Patching Readiness Health Checks. |
PostPatchingHealthChecks.xml |
Primordial |
Run this manifest after applying a patch. See Post Patching Health Checks. |
DataQualityChecks.xml |
Primordial |
Run this manifest to check the quality of data, such as Flex data. Note that these checks might require significant processing time. See Data Quality Check. |
Health Checker calls plug-ins to perform its tasks. This section describes which plug-ins run during the following phases of patching and upgrade processes:
Plug-ins are listed in the order that they are run by Health Checker, within each manifest.
The following checks occur when Health Checker runs the GeneralSystemHealthChecks.xml
manifest:
Validate LDAP Connectivity
Verifies the connectivity to the identity store and policy store LDAP using identity store credentials.
Database Connectivity
Checks if the database instance is up. For RAC databases, checks if all nodes are up.
ODI Repository Check
Finds all jdbc connection URLs in the ODI repository and validates that they point to the same database as the database that is referenced in the DB_CONNECT_STRING
parameter in Fusion_env.properties
.
JAZN Version Check
Verifies that the JAZN version in system-jazn-data.xml
is the same as the version in the policy store.
Identity Store Connectivity
Verifies that the idstore.ldap.provider
in jps-config-jse.xml
can be used to connect to the identity store.
IP Port Range Check
Checks the local port range value in /proc/sys/net/ipv4/ip_local_port_range
. The recommended value is 32768 61000
. If the range is set to any value below 32768
, a system process could potentially use a port that was assigned to one of the Managed Servers. Since RUP Installer requires all domains to be down, those ports are available for the system to use.
ODI Setup Check
Confirms the correct connection URLs exist in the ODI Repository.
Verify Node Managers are Accessible
Verifies that node managers for all hosts are running and are accessible.
Verify Server Status
Confirm that all relevant Administration Servers and Managed Servers have a RUNNING status.
OAM Server Status Check
Verifies OAM server status.
OPMN Managed Processes Up
Verifies the OPMN managed processes are up and running.
OPMN Additional Processes Up Check
Verifies that the status of the OPMN process is up.
OHS OPMN Check
Checks if the OHS process is up on the OHS host using OPMN.
Validate Required AppId
Verifies that all required APPIDs exist in the Identity Store.
File Owner Permissions Check
Validates file and folder ownership and permissions for the file system.
FSMount Check
Verifies Required file system mount points.
Database Schema Validate Version
Verifies FMW and FA Schema Versions.
WSM-PM Check
Verifies that the WSM-PM application is running on all SOA domains.
The following checks occur when running Health Checker during Pre-Downtime, using the PreDowntimeUpgradeReadinessHealthChecks.xml
manifest:
Disk Space Check
Checks for free and usable disk space on the primordial and non-primordial Oracle Fusion Applications hosts.
Locked Objects Check
Verifies that there are no locked objects in the FUSION_ODI
and SES
schemas.
Total Memory Check
Verifies there is sufficient memory for upgrading. The memory requirement calculation is based on the domains and servers that are configured to run where Health Checker runs. Note that the formula used in the Total Memory Check considers only the memory requirements for managed servers, administration servers, and BI clusters. The actual total memory requirements will exceed this calculation. For more information, see Verify Memory Requirements.
SOA Platform is Ready
Verifies whether the SOA platform is ready for each domain that is impacted by the contents of the upgrade.
Web Logic Edit Check
Verifies that no WLS edit sessions or unactivated changes exist.
New Managed Servers Port Availability
Verifies the availability of ports for managed servers that were added.
Tablespace Autoextent Check
Verifies the tablespace is autoextensible.
File Owner Permissions Check
Verifies the permissions and owners of the file.
Invalid Index Check
Checks for unusable indexes in the Fusion Schema of the Oracle Fusion Applications database.
Invalid Objects Check
Checks for and reports any invalid objects.
Fusion Read Only Schema Validation
Validates database connectivity for Fusion read only schemas.
Fusion Schema Validation
Validates database connectivity to all Fusion schemas.
MDS Schema Validation
Checks database connectivity for MDS schemas.
Middleware Schema Connectivity
Checks database connectivity for all schemas except for FUSION_MDS
schemas.
The following checks occur when Health Checker runs the DuringDowntimeUpgradeReadinessHealthChecks.xml
manifest:
Patch Sessions and Processes Check
Verifies that no AD Administration, AutoPatch or Patch Manager processes are running.
Active OPatch Processes Check
Checks active OPatch processes.
Database Instance Connectivity
Checks if the database instance is up. For RAC databases, checks if all nodes are up.
MDS Schema Validation
Checks database connectivity for MDS schemas.
Middleware Schema Validation
Checks database connectivity to Fusion Middleware schemas, with exception of the MDS schemas.
Fusion Read Only Schema Validation
Validates database connectivity for Fusion read only schemas.
Identity Store Connectivity
Verifies that the idstore.ldap.provider
in jps-config-jse.xml
can be used to connect to the identity store.
Verify Node Managers are down
Verifies Node Managers are shut down.
Server Status Down
Confirms that all relevant Administration Servers and Managed Servers are down.
Validate LDAP Connectivity
Verifies the connectivity to the identity store and policy store LDAP using identity store credentials.
JAZN Version Check
Verifies that the JAZN version in system-jazn-data.xml
is the same as the version in the policy store.
Free Memory Check
Verifies free memory and swap space.
OPMN Managed Processes Status
Verifies OPMN managed processes are shut down.
OPMN Managed Process Down
Verifies again that OPMN processes are down.
OdiActiveSessionCheck
Verifies no active or locked ODI sessions exist.
The following checks occur when Health Checker runs the PostUpgradeHealthChecks.xml
manifest:
Language Pack Validation
Checks if a language pack has been upgraded to the current release or needs to be upgraded to the current release.
Patch Sessions and Processes Check
Checks whether any AD Administration, AutoPatch or Patch Manager processes are running.
Active OPatch Processes Check
Verifies no active OPatch process is running.
Locked Objects Check
Verifies that there are no locked objects in the FUSION_ODI
and SES
schemas.
WLS Edit Sessions and Unactivated Changes
Verifies that no WLS edit sessions or unactivated changes exist.
SOA Platform Check
Verifies whether the SOA platform is ready for each domain that is impacted by the contents of the upgrade.
Fusion Read Only Schema Validation
Validates database connectivity for Fusion read only schemas.
Fusion Schema Validation
Validates database connectivity to all Fusion schemas.
MDS Schema Validation
Checks database connectivity for MDS schemas.
Middleware Schema Connectivity
Checks database connectivity for all schemas except for FUSION_MDS
schemas.
The following checks occur when Health Checker runs the LanguagePackReadinessHealthChecks.xml
manifest. This manifest is typically run before installing a language pack.
Patch Sessions and Processes Check
Verifies that no AD Administration, AutoPatch or Patch Manager processes are running
Active OPatch Processes Check
Checks active OPatch Processes
For more information, see Perform Optional Language Installations in the Oracle Fusion Applications Installation Guide
The PostLanguagePackHealthChecks.xml
manifest is typically run after installing a language pack. The following check occurs when Health Checker runs this manifest:
Language Pack Validation
Verifies that the SOA platform is ready for each domain that is impacted by the contents of the language pack.
The PatchingReadinessHealthChecks.xml
manifest is typically before applying a patch. The following checks occur when Health Checker runs this manifest:
JAZN Version Check
Verifies the JAZN version in Oracle home matches with the policy store.
Patch Sessions and Processes Check
Verifies that no AD Administration, AutoPatch or Patch Manager processes are running.
Active OPatch Processes Check
Verifies Active OPatch Processes
Locked Objects Check
Verifies there are no locked objects in the FUSION_ODI
or SES
schema.
Web Logic Conflict Check
Verifies that no WLS edit sessions or unactivated changes exist.
Database Connectivity Check
Verifies database instance connectivity.
Invalid Index Check
Checks for unusable indexes in the Fusion Schema of the Oracle Fusion Applications database.
Invalid Objects Check
Checks for and reports any invalid objects.
The PostPatchingHealthChecks.xml
manifest is typically run after applying a patch. The following checks occur when Health Checker runs the manifest:
JAZN Version Check
Verifies that the JAZN version in system-jazn-data.xml
is the same as the version in the policy store.
Patch Sessions and Processes Check
Verifies that no AD Administration, AutoPatch, or Patch Manager processes are running.
Active OPatch Processes Check
Checks active OPatch processes.
Locked Objects Check
Verifies that there are no locked objects in the FUSION_ODI
or SES
schema.
Web Logic Conflict Check
Verifies that no WLS edit sessions or unactivated changes exist.
The following check occurs when Health Checker runs the DataQualityChecks.xml
manifest:
FlexDataCheck
Validates Flex Data Integrity
The following checks occur when Health Checker runs the VitalSignsChecks.xml
manifest:
Middleware Schema Connectivity
Checks database connectivity for all schemas except for FUSION_MDS
schemas.
Fusion Read Only Schema Validation
Validates database connectivity for Fusion read only schemas.
Database Instance Connectivity
Checks if the database instance is up. For RAC databases, checks if all nodes are up.
Fusion Schema Validation
Validates database connectivity to all Fusion schemas.
MDS Schema Validation
Checks database connectivity for MDS schemas.
Identity Store Connectivity
Verifies that the idstore.ldap.provider
in jps-config-jse.xml
can be used to connect to the identity store.
Validate LDAP Connectivity
Verifies the connectivity to the identity store and policy store LDAP using identity store credentials.
Verify Server Status
Verifies that all Administration and Managed Servers are up.
The Health Checker utility offers a method to manage which health checks run on the Oracle Fusion Applications environment. For example, a health check that is related to a known issue in an environment may need to be excluded. The configuration parameters for Health Checker are stored in the REPOSITORY_LOCATION
/installers/farup/Disk1/upgrade/config/healthchecks.xml
file. This file cannot be edited. If there is a need to override any configuration parameters or exclude certain plug-ins from running, it is possible to create configuration override files. Health Checker first loads the configuration parameters that are stored in healthchecks.xml
and then it considers the configuration override files.
The Health Checker override files are staged under SHARED_UPGRADE_LOCATION/healthchecker/common
as follows:
all_overrides.xml
FA_pods_overrides.xml.template
Where SHARED_UPGRADE_LOCATION
is a property defined in the pod.properties file.
The following topics are discussed in this section:
The all_overrides.xml
file will define plug-in exclusions. These exclusions are applicable across the fleet. Checks disabled out of the box, and checks disabled due to emergency patch will be combined in this file. This file cannot be edited.
The file FA_pods_overrides.xml
can be used to define custom/pod-specific check exclusions. If there is a need to exclude a specific plugin, or to re-enable one of the excluded plugins, use this file as it will have higher precedence than all_overrides.xml
.
FA_pods_overrides.xml
file is already there, continue using it. If you do not have the file, then make a copy of FA_pods_overrides.xml.template
, and rename it to FA_pods_overrides.xml
as follows, all in one command line:
cp SHARED_UPGRADE_LOCATION/healthchecker/common/FA_pods_overrides.xml.template SHARED_UPGRADE_LOCATION/healthchecker/common/FA_pods_overrides.xml
<plugin id="DiskSpaceCheckPlugin" description="Verifying Free Disk Space" invoke="$HC_LOCATION/config/diskfree_checks.xml" plugin.class="oracle.check.diskfree.plugin.DiskSpaceCheckPlugin"
FA_pods_overrides.xml
file using the plug-in ID, perform the following steps:
Note that to-be-excluded plug-ins must be listed under the "exclude" category in FA_pods_overrides.xml
.
FusionSchemaValidation
for a pod named abc, perform the following steps:FusionSchemaValidation
plugin for pods abc, xxx, and zzz, perform the following steps:The following example shows an exclusion in the all_overrides.xml
file:
<checks category="exclude"> <check name="TablespaceCheckPlugin"/> </checks>
TablespaceCheckPlugin
for all pods, perform the following steps:It is possible to exclude a plug-in for a specific host, a specific version of the Oracle Fusion Cloud Application, or a combination of both.
DiskSpaceCheckPlugin
from running on the OHS host and for the Oracle Fusion Cloud Application version 11.12.0.0.0:
<checks category="exclude"> <!-- Exclude diskspace check on the OHS host --> <check name="DiskSpaceCheckPlugin" host="OHS"/> <!-- Exclude diskspace check if installed version in APPLTOP is 11.12.0.0.0 --> <check name="DiskSpaceCheckPlugin" fa_version="11.12.0.0.0"/> <!-- Exclude diskspace check on OHS host if installed FA version is 11.12.0.0.0 --> <check name="DiskSpaceCheckPlugin" host="OHS" fa_version="11.12.0.0.0"/> </checks>
PRIMORDIAL
MIDTIER
OHS
The RUP Lite for OVM utility addresses the differences between a newly provisioned Oracle Virtual Machine (VM) environment on the latest release and an Oracle VM environment provisioned in a previous release. Run RUP Lite for OVM only if Oracle Fusion Applications is running in an Oracle VM environment that was created from the official releases of Oracle VM templates for Oracle Fusion Applications Release 2 (11.1.2) and higher. This utility is not applicable for any Oracle VM environments that are created using other methods.
The following is an example location for running RUP Lite for OVM in offline mode:
/u01/APPLTOP/instance/lcm/rupliteovm/output/11.12.x.0.0/mycompany.com/rupliteoffline.log
RUP Lite for OVM implements several plug-ins that are designed specifically for Oracle VM environments. Each plug-in determines which nodes it needs to run on and in which mode it must run. The following table describes the plug-ins that are included in RUP Lite for OVM in pre-root mode.
Table 10-7 Pre-Root Plug-ins for RUP Lite for OVM
Plug-in Name | Mandatory | Description |
---|---|---|
RequireRoot |
Yes |
Sets the require root flag to true so that RUP Lite for OVM checks that the root user is used for the pre-root mode. |
ValidateEnvironment |
Yes |
Checks if the node is a valid Oracle VM node. This plug-in always runs and has no properties. |
SetupCredentials |
Yes |
Prompts for credentials and stores the results in a secure manner for other plug-ins to use. This plug-in always runs and only prompts for secure properties that are needed by other plug-ins that will run. If a plug-in does not run on the current node or is disabled, then its properties are not requested. |
AutoCorrectEtcHosts |
Yes |
Executes for both primary and standby PODs and calls the EtcHosts utility, which in turn corrects the |
InstallStartStopInitd |
Yes |
Installs |
ModifyOutputOwner |
Yes |
Modifies RUP Lite for OVM files to be owned by the application user instead of root. It is targeted primarily for output files that are created as root-owned files during RUP Lite for OVM execution. |
The following table describes the plug-ins that are included in RUP Lite for OVM in offline mode.
Table 10-8 Offline Plug-ins for RUP Lite for OVM
Plug-in Name | Mandatory | Description |
---|---|---|
ValidateEnvironment |
Yes |
Checks if the node is a valid Oracle VM node. This plug-in always runs and has no properties. |
SetupCredentials |
Yes |
Prompts for credentials and stores the results in a secure manner for other plug-ins to use. This plug-in always runs and only prompts for secure properties that are needed by other plug-ins that will run. If a plug-in does not run on the current node or is disabled, then its properties are not requested. |
GenerateOptimizedQueryPlans |
Yes |
Generates optimized query plans for Oracle MDS queries. |
CreatePodscratchDirs |
No (On-Premise) Yes (SaaS Only) |
Reuses the metadata file that has the list of directories to be created from rehydration. This metadata file is packaged and placed under |
The following table describes the plug-ins that are included in RUP Lite for OVM in online mode.
Table 10-9 Online Plug-ins for RUP Lite for OVM
Plug-in Name | Mandatory | Description |
---|---|---|
ValidateEnvironment |
Yes |
Checks if the node is a valid Oracle VM node. This plug-in always runs and does not have any properties. |
SetupCredentials |
Yes |
Prompts for credentials for online plug-ins and stores the results in a secure manner for other plug-ins to use. This plug-in always runs and only prompts for secure properties that are needed by other plug-ins that will run. If a plug-in does not run on the current node or is disabled, then its properties are not requested. You are prompted for the password twice. |
DeployECSF |
Yes |
Deploys ECSF artifacts that are not yet deployed, such as search objects, search categories, and index schedules. |
Table 10-10 Post-Root Plug-ins for RUP Lite for OVM
Plug-in Name | Mandatory | Description |
---|---|---|
RequireRoot | N/A | N/A |
ValidateEnvironment | Yes | Checks if the node is a valid Oracle VM node. This plug-in always runs and does not have any properties. |
SetupCredentials | Yes | Prompts for credentials for online plug-ins and stores the results in a secure manner for other plug-ins to use. This plug-in always runs and only prompts for secure properties that are needed by other plug-ins that will run. If a plug-in does not run on the current node or is disabled, then its properties are not requested. You are prompted for the password twice. |
ModifyOutputOwner | Yes |
Modifies RUP Lite for OVM files to be owned by the application user instead of root. It is targeted primarily for output files that are created as root-owned files during RUP Lite for OVM execution. |
The RUP Lite for OHS utility manages the steps required to update WebGate, WebTier, and ORACLE_COMMON. The following steps are performed by RUP Lite for OHS to accomplish this upgrade:
Stop Oracle Process Manager and Notification Server (OPMN) processes.
Apply OPatches from the repository to WebGate, WebTier, and ORACLE_COMMON.
Apply manually downloaded OPatches to WebGate, WebTier, and ORACLE_COMMON.
Update the OHS configuration files.
Apply OHS settings changes.
Re-register OHS.
Start the OPMN server process.
Start the OHS instance.