B Upgrade Orchestrator Properties Files

This appendix describes the properties files used by Upgrade Orchestrator.

To configure any property, follow the instructions for each property's description in the respective property file. The following properties files are required by Upgrade Orchestrator:

pod.properties
PRIMORDIAL.properties
MIDTIER.properties
IDM.properties
OHS.properties

Table B-1 pod.properties

Property Name	Mandatory	Description
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	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	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	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 Webtier (APPOHS).
HOSTNAME_IDMOID	Yes	Host name, virtual or actual, of the OID server, for example, `server_name.oracleoutsourcing.com`.
HOSTNAME_IDMOIM	Yes	Host name, virtual or actual, of the OIM server, for example, `server_name.oracleoutsourcing.com`.
HOSTNAME_IDMOHS	Yes	Host name, virtual or actual, of the AuthOHS server, for example, `server_name.oracleoutsourcing.com`.
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.
REL6_REPOSITORY_LOCATION	No	The location where the Release 6 repository is downloaded to a shared mount, for example `SHARED_LOCATION/11.1.6.0.0/Repository`. As a best practice, it should be on the shared mount that is shared across all pods or environments. This is mandatory only for chained upgrade from Release 5 to Release 6 to Release 7.
REL7_REPOSITORY_LOCATION	Yes	The location where the Release 7 repository is downloaded to a shared mount, for example `SHARED_LOCATION/11.1.7.0.0/Repository`. As a best practice, it should be on the shared mount that is shared across all pods or environments.
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. You can 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_CONFLICT_MANAGER_LOCATION	Yes	The location of the patch conflict manager utility that you create in Section 2.3.2.1, "Patch Conflict Manager Directory." The default value is`/u01/PatchConflictManager`.
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.
PRE_REL6_SAAS_FACONTROL_SCRIPTS_LOCATION	No	This property is not applicable.
SHARED_RDBMS_HOME	No	This property is not applicable.
REL6_SAAS_LCM_INSTALLER_DIR	No	This property is applicable to Oracle Fusion Applications VMs only. This is the directory where F`ASAASLCMTOOLS.zip` is downloaded and unzipped. As a best practice it should be on the shared mount that is shared across all pods/environments. This is mandatory only for the chained upgrade from Release 5 to Release 6 to Release 7. `SHARED_LOCATION/11.1.6.0.0/fasaaslcmtools` is an example.
REL7_SAAS_LCM_INSTALLER_DIR	Yes for Oracle VM	This property is applicable to Oracle Fusion Applications VMs only. This is the directory where F`ASAASLCMTOOLS.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.1.7.0.0/fasaaslcmtools` is an example.
ORCH_REPORT_LOCATION	No	A shared location accessible to all hosts that is used to save the upgrade report, as described in Section 1.3.4, "Oracle Fusion Applications Orchestrator Upgrade Report."
REL6_DOWNLOADED_PATCHES_LOCATION	No	The location of the post-release 6 patches that are identified as critical for upgrade, as described in Section 2.3.5.2, "Download and Unzip Mandatory Post-Release 6 Patches." This directory should be on a shared mount point shared across all hosts and ideally all pods, for example, `SHARED_LOCATION/`1`1.1.6.0.0_post_repo_patches`.
REL7_DOWNLOADED_PATCHES_LOCATION	No	The location of the post-release 7 patches that are identified as critical for upgrade, as described in Section 2.3.6.3, "Download and Unzip Mandatory Post-Release 7 Patches." This directory should be on a shared mount point shared across all hosts and ideally all pods, for example, `SHARED_LOCATION/`1`1.1.7.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 set to false by default and should be ignored.

Table B-2 PRIMORDIAL.properties

Property Name	Mandatory	Description
REL7_LP_REPOSITORY_LOCATION	Yes, if upgrading languages	The location of all Release 7 Language Pack repositories, as described in Section 2.3.6.2, "Download and Unzip Release 7 Language Packs." This directory should be on a shared mount point shared across all pods/environments, for example `SHARED_LOCATION/11.1.7.0.0/LPRepository /u01/rel7LPRepositoryLocation`.
REL6_RUPINSTALLER_UPGRADE_PARAM	No	You can leave this property blank because its value is automatically set by Upgrade Orchestrator during the upgrade. Alternatively, you can provide a space separated list of command line options passed to the RUP and Language Pack installers. For a list of options, refer to "Table 3-6" in the Oracle Fusion Applications Administrator's Guide. If you set this parameter manually, use only -D options. Do not use -J-D options.
REL7_RUPINSTALLER_UPGRADE_PARAM	No	You can leave this property blank because its value is automatically set by Upgrade Orchestrator during the upgrade. Alternatively, you can provide a space separated list of command line options passed to the RUP and Language Pack installers. For a list of options, refer to "Table 3-6" in the Oracle Fusion Applications Administrator's Guide. If you set this parameter manually, use only -D options. Do not use -J-D options.
MANIFEST_FILE	Yes	The file name and location for the .xml manifest file for the host type and the upgrade level. For a release 7 upgrade, the value should be `ORCH_LOCATION/config/rel7_primordial.xml`. For multi-hop upgrade, the value should be `ORCH_LOCATION/config/rel5-7_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/jdk6`.
CSF_SYSTEM_USERS_ENCRYPTED_INI	Yes	The absolute path and filename for the encrypted .ini file for adding new system users, for example, `/APPTOP/instance/lcm/admin/pcu/system_user_encrypted.ini`. For more information, see Section 2.4.2.4, "Prepare to Register System User Information."
CSF_ENCRYPTED_FILE	Yes	The absolute path and filename for the CSF encrypted file generated by the iniGen.sh script. This property is used by orchestration to pass the value to schemaPasswordChangeTool.sh. For more information, see Section 2.4.2.3, "Prepare to Register Database Schema Information."
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 Be a previously installed language Not be the JAZN policy store language

Table B-3 MIDTIER.properties

Property Name	Mandatory	Default Value
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 a release 7 upgrade, the value should be `ORCH_LOCATION/config/rel7_midtier.xml`. For multi-hop upgrade, the value should be `ORCH_LOCATION/config/rel5-7_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/jdk6`.
RUPLITE_DOMAIN_CONFIG_COPY_LOCATION	No	The read/write location to copy the `ruplite` domain config folder and files from the primordial host after RUP Installer Part 1 completes. If you do not have local domains, you can leave this property blank. This location must be local where local domains exists on the Midtier host and not the shared mount point.If you do not have local domains, you can leave this properly blank. The default value is `/u01/ruplitedomain`.

Table B-4 IDM.properties

Property Name	Mandatory	Default Value
MANIFEST_FILE	Yes	The file name and location for the .xml manifest file for the host type and the upgrade level. For a release 7 upgrade, the value should be `ORCH_LOCATION/config/rel7_idm.xml`. For multi-hop upgrade, the value should be `ORCH_LOCATION/config/rel5-7_idm.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/jdk6`.
IDM_SETUP_TYPE	Yes	Set this property to IDM node types. Valid values are SINGLE, 3-NODE, AND 4-NODE. The default value is 4-NODE.
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.

Table B-5 OHS.properties

Property Name	Mandatory	Default Value
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 a release 7 upgrade, the value should be `ORCH_LOCATION/config/rel7_ohs.xml`. For multi-hop upgrade, the value should be `ORCH_LOCATION/config/rel5-7_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. An example 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, `/oracle/work/MW_HOME`. 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 Oracle WT1 directory, which is a sub-directory under `WT_MW_HOME`, for example: `/oracle/work/MW_HOME/Oracle_WT1`. 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 Oracle WT1 location on the specific host.
WT_CONFIG_HOME	Yes	Location of the web tier instance directory, for example, `/oracle/work/MW_HOME/Oracle_WT1/instances/instance1`. 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.