11 Upgrade Orchestrator Properties Files

ORCHESTRATION_CHECKPOINT_LOCATION

Yes

The shared location, available to all hosts in the environment, where files related to the orchestration checkpoint are saved. Select a shared mount point that has high disk I/O performance, especially for writing. Upgrade Orchestrator automatically creates POD_NAME under the directory you specify. It is a best practice to not use ORCH_LOCATION/config as a value for this property.

ORCHESTRATION_CHECKPOINT_ARCHIVE_LOCATION

Yes

The shared location, available to all hosts in the environment, where files related to the orchestration checkpoint are saved. Select a shared mount point that has high disk I/O performance, especially for writing. Upgrade Orchestrator automatically archives the checkpoint file stored under the POD_NAME directory under the directory specified by the ORCHESTRATION_CHECKPOINT_LOCATION. property. It is a best practice to not use ORCH_LOCATION/config as a value for this property.

HOSTNAME_PRIMORDIAL

Yes

The host name of your Oracle Fusion Applications primordial host. This must be one and only one host name.

HOSTNAME_MIDTIER

Yes

A comma separated list of all host names of your Oracle Fusion Applications Midtier hosts. In Oracle VM environments, this must be a comma separated list of host names for primary, secondary, bi and osn hosts.

HOSTNAME_PRIMARY

Yes, for Oracle VM

A comma separated list of all host names of your Oracle Fusion Applications primary hosts. This is applicable only for Oracle VM environments.

HOSTNAME_SECONDARY

Yes, for Oracle VM

A comma separated list of all host names of your Oracle Fusion Applications secondary hosts. This is applicable only for Oracle VM environments.

HOSTNAME_BIINSTANCE

Yes, for Oracle VM

A comma separated list of all host names of your Oracle Fusion Applications BI hosts. This is applicable only for Oracle VM environments.

HOSTNAME_OSN

Yes

This property is not applicable.

HOSTNAME_OHS

Yes

A comma separated list of all host names for the Oracle Fusion Applications Web Tier (APPOHS).

HOSTNAME_IDMOID

Yes

Host name, virtual or actual, of the OID server, for example, host_name.oracleoutsourcing.com.

HOSTNAME_IDMOIM

Yes

Host name, virtual or actual, of the OIM server, for example, host_name.oracleoutsourcing.com.

HOSTNAME_IDMOHS

Yes

Host name, virtual or actual, of the AuthOHS server, for example, host_name.oracleoutsourcing.com.

HOSTNAME_GRC

No

Comma separated list of all host names for the VM GRC. This is an optional property for the midtier. Any host names present in this property must also be present in the HOSTNAME_MIDTIER property.

EMAIL_TO_RECIPIENT

Yes

A comma separated list of email addresses to whom the upgrade notifications are sent. Test that recipients can receive emails by sending a test mail using sendmail or using the SMTP configuration specified in the SMTP_* properties if sendmail is not configured on this host.

EMAIL_CC_RECIPIENT

No

A comma separated list of email addresses to whom the upgrade notifications are sent as copies. Test that recipients can receive emails by sending a test mail using sendmail or using the SMTP configuration specified in the SMTP_* properties if sendmail is not configured on this host.

EMAIL_SENDER

No

The email address of the sender from which you want notifications to be sent. This must be a single value, such as no-reply@domain.com.

EMAIL_DEFAULT_ENGINE

Yes

Valid email engine that can be used on all hosts for this pod. The default value is /usr/sbin/sendmail.

EMAIL_PROTOCOL

No

Value must always be smtp as that is only supported protocol.

SMTP_HOSTNAME

No

The valid smtp host name. The default value is localhost.

SMTP_PORT_NUMBER

No

The SMTP protocol port number.

SMTP_AUTHORIZATION

No

A true or false value to indicate whether authorization key is used to connect to the SMTP server. The default value is false.

SMTP_AUTH_USER

No

The SMTP authorized user id.

SMTP_AUTH_PASSWORD

No

The SMTP authorized password.

SMTP_AUTH_ENCRYPTED_PASSWORD

No

The encrypted SMTP authorized password. If this property is empty, the SMTP_AUTH_PASSWORD value is used.

SMTP_SOCKETFACTORY_CLASS

No

The factory class name to connect to the SMTP server.

REL12_REPOSITORY_LOCATION

Yes

The location where the Release 12 repository is downloaded to a shared mount, for example SHARED_LOCATION/11.12.x.0.0/Repository. As a best practice, it should be on the shared mount that is shared across all pods or environments.

REL12_LP_REPOSITORY_LOCATION

Yes, if upgrading languages

The location of all Release 12 Language Pack repositories, as described in Download and Unzip Release 12 Language Packs. As a best practice, this directory should be on a shared mount point that is shared across all pods or environments, for example, SHARED_LOCATION/11.12.x.0.0/LPRepository.

REL12_RUPINSTALLER_UPGRADE_PARAM

Yes, for non-Oracle VM

Enter the location for the override file that was created in Create an Override File for RUP Installer. It is also possible to provide a space separated list of command line options passed to the RUP and Language Pack installers. For a list of options, see Table 16-2 in the Oracle Fusion Applications Installation Guide. If this parameter is set manually, use only -D options. Do not use -J-D options.

SKIP_UPGRADE_FOR_LANGUAGE

No

A comma separated list of languages that you do not want orchestration to upgrade. The list items must:

• Meet ISO language code convention. If the ISO_LANGUAGE code is the same for more than one TERRITORY, enter the format of ISO_LANGUAGE_ISO_TERRITORY. For example, if ISO_LANGUAGE code is zh, need to enter either zh_TW or zh_CN but not zh.

• Be a previously installed language

• Not be the JAZN policy store language

SHARED_UPGRADE_LOCATION

Yes

The temporary directory where Upgrade Orchestrator copies files and perform write operations. Select a shared mount point that is shared across all hosts for a given pod/environment that has high disk I/O performance, especially for writing. You can clean up this area after your upgrade is complete. The default value is /u01/SHARED_UPGRADE_LOCATION.

THREAD_POOL_SIZE

Yes

This property is used for parallel execution of tasks within orchestration. It is possible to choose to change the default value of 10 to a different numeric value if you want to control how many tasks run in parallel. For example, a value of 1 means everything runs sequentially, a value of 2 means only two tasks can run in parallel.

PATCH_ROLLBACK_UTILITY_LOCATION

Yes

The location of the patch rollback automation utility created in Download and Unzip the Patch Rollback Automation Script. The default value is /u01/PatchRollbackUtil.

SAAS_ENV

Yes

This property should be set to true only if your Oracle VM environments are created in the Oracle Cloud Customer Environment.

SAAS_FACONTROL_SCRIPTS_LOCATION

No

This property is not applicable.

REL12_SAAS_LCM_INSTALLER_DIR

Yes for Oracle VM

This property is applicable to Oracle Fusion Applications VMs only. This is the directory where FASAASLCMTOOLS.zip is downloaded and unzipped. As a best practice it should be on the shared mount that is shared across all pods/environments. SHARED_LOCATION/11.12.x.0.0/fasaaslcmtools is an example.

ORCH_REPORT_LOCATION

Yes

A shared location accessible to all hosts that is used to save the orchestration report, as described in Oracle Fusion Applications Orchestration Report.

REL12_DOWNLOADED_PATCHES_LOCATION

No

The location of the post-Release 12 patches that are identified as critical to prevent upgrade failures, as described in Download and Unzip Mandatory Post-Release 12 Patches. This directory should be on a shared mount point shared across all hosts and ideally all pods, for example, SHARED_LOCATION/11.12.x.0.0/11.12.x.0.0_post_repo_patches.

HC_OVERRIDE_FILES

No

The location of the directory that contains Health Checker configuration override files. The default value is APPLICATIONS_CONFIG/fapatch/healthchecker.

FORCE_OSN_ENABLED

No

This property is not applicable.

ORCH_JVM_OPTIONS

No

This property is not applicable.

RUN_PREDOWNTIME_CHECKS

No

This property indicates whether orchestration runs the pre-downtime health checks and the preValidation check in IDM hosts.

By default, this property is set to false to indicate that orchestration does not run pre-downtime checks on any host. It is recommended that you do not enable this property by setting its value to true unless otherwise required.

PERFORM_INCREMENTAL_PROVISIONING

Yes

This property can be set to true to indicate that Incremental Provisioning should be performed by orchestration. The default value is false.

INC_PROV_BINARY_HOME

Yes, conditionally, see Description

This property is the path to the directory where incremental provisioning binaries are installed. This location must be accessible from all hosts within a POD. If the directory already exists, it must be empty before orchestration runs. This property is mandatory if PERFORM_INCREMENTAL_PROVISIONING is set to true; it is ignored otherwise.

RESPONSE_FILES_DIR_LOC

No

This property is applicable only if the PERFORM_INCREMENTAL_PROVISIONING property is set to true.

EMAIL_STARTNOTIFICATION_DELAY

No

The default value is 120 (seconds), and the value should be in the range of [0,300], which represents no delay to a maximum 5 minutes delay for email notifications.

EMAIL_LEVEL

Yes

This property describes the level of email notifications that users receive from Upgrade Orchestration. It is set to INFO by default. Valid values are:

• INFO: Users receive all emails

• ALERT: Users receive alert and pause point emails

• PAUSEPOINT: Users receive only pause point emails

• NONE: No emails are sent

FA_CURRENT_VERSION

Yes

The current release of your Oracle Fusion Applications environment, for example, 11.1.8.0.0 or 11.1.9.1.0.

FA_TARGET_VERSION

Yes

The release of Oracle Fusion Applications to which you want to upgrade this environment, such as 11.12.x.0.0.

RUN_LP_FROM_HOST

Yes, if language packs are installed

The host on which you run Language Pack Installer. This must be one of the Primordial or Midtier hosts.

SMARTCLONE_ENABLED

Yes

This property indicates whether the pod is SmartClone enabled. Valid values are true and false. The default value is false.

MANIFEST_FILE

Yes

The file name and location for the .xml manifest file for the host type and the upgrade level.

For the Release 12 upgrade, the value should be ORCH_LOCATION/config/rel12_primordial.xml.

APPLICATIONS_BASE

Yes

The top-level directory for the Oracle Fusion Applications binaries. The default value is /u01/APPLTOP.

JRE_LOC

Yes

The absolute path where the Java Runtime Environment is installed. This option does not support relative paths. The default value is /u01/APPLTOP/fusionapps/jdk.

PRE_UPGRADE_JRE_LOC

Yes

The absolute path where the Java Runtime Environment is installed during pre-upgrade activities. This property does not support relative paths. The default value is /u01/APPLTOP/fusionapps/jdk6.

CSF_ENCRYPTED_FILE

Yes

The absolute path and file name for the CSF encrypted file generated by the iniGen.sh script.

This property is used by Orchestration to pass the value to schemaPasswordChangeTool.sh.

• If you use -output file_name to specify an output file name, the value of this property is:

  PCU_LOCATION/fusionapps/applications/lcm/util/config/file_name.ini
  

• If you do not specify an output file name, iniGen.sh generates the following:

  PCU_LOCATION/fusionapps/applications/lcm/util/config/csf_encrypted.ini
  

Note that PCU_LOCATION is defined in PRIMORDIAL.properties also.

PCU_LOCATION

Yes

The temporary location where pcubindle.zip is unzipped in Prepare to Register Database Schema Information.

CSF_SYSTEM_USERS_ENCRYPTED_INI

Yes

The absolute path and file name for the encrypted .ini file for adding new system users. An example is PCU_LOCATION/fusionapps/applications/lcm/util/config/system_user_encrypted.ini.

Note that PCU_LOCATION is defined in PRIMORDIAL.properties also.

REL12_FASAAS_INSTALLER_DIR

Yes, if SAAS_ENV is true

The absolute path to the Saas Home installer directory. This is relevant only to SaaS environments and is ignored on non-SaaS environments.

APPLICATIONS_BASE

Yes

The top-level directory for the Oracle Fusion Applications binaries. The default value is /u01/APPLTOP.

MANIFEST_FILE

Yes

The file name and location for the .xml manifest file for the host type and the upgrade level.

For the Release 12 upgrade, the value should be ORCH_LOCATION/config/rel12_midtier.xml.

JRE_LOC

Yes

The absolute path where the Java Runtime Environment is installed. This option does not support relative paths. The default value is /u01/APPLTOP/fusionapps/jdk.

PRE_UPGRADE_JRE_LOC

Yes

Path where Java Runtime Environment (version 6) is installed during pre-upgrade activities for a Release 12 Upgrade. In Release 12 JDK is upgraded from JDK6 to JDK7.

MANIFEST_FILE

Yes

The file name and location for the .xml manifest file for the host type and the upgrade level.

For the Release 12 upgrade, the value should be ORCH_LOCATION/config/rel12_idm.xml.

JRE_LOC

Yes

The path where the Java Runtime Environment is installed.

IDM_SETUP_TYPE

Yes

The IDM Upgrade is supported by Upgrade Orchestrator, if your deployment is a Linux-64 bit platform and is Release 7 IDM provisioned. This property indicates topology configuration of the system to be upgraded.

REL12_IDM_UPGRADE_BINARIES_LOCATION

Optional

The location where Release 12 IDM binaries are downloaded, for example SHARED_LOCATION/11.12.x.0.0/idmUpgrade. This property is not used for the manual IDM upgrade.

REL12_IDM_UPGRADE_AUTOMATION_PROPERTIES_FILE

Optional

The absolute location of the upgradeOnpremise.properties file to be used by the Release 12 IDM upgrade scripts. All properties related to IDM nodes (OID, OIM and OHS) are maintained in this file. This property is not used for the manual IDM upgrade.

LOG_LOCATION

Yes

The location for all logs to be written. This directory can be host specific or it can be on a shared mount. Select a directory that has high disk I/O performance especially for writing.

PERL_LOCATION

Yes

The location where Perl binary is installed. The default value is /usr.

APPLICATIONS_BASE

Yes

The top-level directory for the Oracle Fusion Applications binaries. The default value is /u01/APPLTOP.

MANIFEST_FILE

Yes

The file name and location for the .xml manifest file for the host type and the upgrade level.

For the Release 12 upgrade, the value should be ORCH_LOCATION/config/rel12_ohs.xml.

RUPLITEOHS_UNZIP_LOCATION

Yes

Specify a location, local to the OHS host, where the webgate install zip file should be unzipped, to be used by the RUP Lite for OHS upgrade, for example, /u01/webgate.

JRE_LOC

Yes

The absolute path where the Java Runtime Environment is installed. This option does not support relative paths. The default value is ORCH_LOCATION/jdk.

LOG_LOCATION

Yes

Location for logs to be written.

WT_MW_HOME

Yes

Location of the Web Tier MW_HOME, for example, /APPTOP/webtier_mwhome. If you have scaled out OHS hosts, copy this property for each OHS host, prefixed with the host name of the host to indicate the Web Tier MW_HOME location on the specific host.

WT_ORACLE_HOME

Yes

Location of the Web Tier instance configuration home, for example, /APPTOP/webtier_mwhome/webtier. If you have scaled out OHS hosts, copy this property for each OHS host, prefixed with the host name of the host to indicate the webtier directory location on the specific host.

WT_CONFIG_HOME

Yes

Location of the Web Tier instance directory, for example, /APPTOP/instance/CommonDomain_webtier. If you have scaled out OHS hosts, copy this property for each OHS host, prefixed with the host name of the host to indicate the Web Tier WT_CONFIG_HOME location on the specific host.

OHS_INSTANCE_ID

Yes

The OHS instance ID on the host. Normally this is ohs1 and is the value for ias-component id in the opmn.xml file. If you have scaled out OHS hosts, copy this property for each OHS host, prefixed with the host name of the host to indicate the OHS_INSTANCE_ID on the specific host.

OHS_UPGRADE_BINARIES_HOSTNAME

Yes

Comma separated list of your OHS host names which do not share the binaries.

SUPPLIER_PORTAL_VIRTUAL_HOSTNAME

Conditional

The external virtual host name dedicated to the Supplier Portal application. This property is mandatory if the Virtual Host Mode is "NAME". If you have scaled out OHS hosts, copy this property for each OHS host, prefixed with the host name of the host, to indicate the external virtual host name dedicated to the Supplier Portal application on the specific host.

SUPPLIER_PORTAL_VIRTUAL_PORT

Conditional

The external virtual host port dedicated to the Supplier Portal application. This property is mandatory if the Virtual Host Mode is "IP" or "PORT". If you have scaled out OHS hosts, copy this property for each OHS host, prefixed with the host name of the host to indicate the external virtual host port dedicated to the Supplier Portal application on the specific host.