3 Performing the Oracle GoldenGate Studio Upgrade

The Oracle GoldenGate Studio upgrade from a previous 12c release to 12c ( is performed in-place; that is, the upgrade operations are performed on the existing 12c domain.

High-level upgrade steps:

3.1 About the Oracle GoldenGate Studio Upgrade Process

Review the flowchart and roadmap for an overview of the upgrade process for Oracle GoldenGate Studio .

The steps you take to upgrade your existing domain varies depending on how your domain is configured and which components are being upgraded. Follow only those steps that are applicable to your deployment.

Figure 3-1 Upgrade Process Flowchart for Oracle GoldenGate Studio

Description of Figure 3-1 follows
Description of "Figure 3-1 Upgrade Process Flowchart for Oracle GoldenGate Studio"
The following table lists the high-level steps that you need to perform to upgrade to Oracle GoldenGate Studio 12c (

Table 3-1 Tasks for Upgrading Oracle GoldenGate Studio

Task Description


If you have not done so already, review the introductory topics in this guide and complete the required pre-upgrade tasks.

The pre-upgrade tasks include cloning your production environment, verifying system requirements and certifications, purging unused data, and creating non-SYSDBA user.

For a complete list of pre-upgrade tasks, see Preparing to Upgrade Oracle GoldenGate Studio.


Shut down the connection to the existing 12c repository.

Before starting the upgrade process, shut down the connection to the 12c ( repository.

WARNING: Failure to shut down your servers during an upgrade may lead to data corruption.

See Stopping Servers and Processes.


Download and install the Oracle GoldenGate Studio 12c ( distribution in the new Oracle home.

To install the product distribution, see Installing Oracle GoldenGate Studio.


Upgrade the existing schemas with the Upgrade Assistant.

The schemas you created during the 12c (12.2.1.x) installation are supported in 12c ( Therefore, you do not need to create the schemas again.

You must upgrade all the repository schemas by using Upgrade Assistant. See Using the Oracle Fusion Middleware Upgrade Assistant to Upgrade Product Schemas.


Connect to the 12c ( repository and verify your upgrade.

The upgrade process is complete. You can now verify the 12c ( instance to compare the previous 12c environment with the 12c ( and verify the data and configuration settings are consistent in the newly upgraded environment.

3.2 Stopping Servers and Processes

Before running the Upgrade Assistant to upgrade your schemas and configurations, you must shut down all processes and servers, including the Administration server and any managed servers.

An Oracle Fusion Middleware environment can consist of an Oracle WebLogic Server domain, an Administration Server, multiple managed servers, Java components, system components such as Identity Management components, and a database used as a repository for metadata. The components may be dependent on each other so they must be stopped in the correct order.


The procedures in this section describe how to stop servers and processes using the WLST command-line utility or a script. You can also use the Oracle Fusion Middleware Control and the Oracle WebLogic Server Administration Console. See Starting and Stopping Administration and Managed Servers and Node Manager in Administering Oracle Fusion Middleware.

To stop your Fusion Middleware environment, follow the steps below.

Step 1: Stop System Components

To stop system components, such as Oracle HTTP Server, use the stopComponent script:

  • (UNIX) DOMAIN_HOME/bin/stopComponent.sh component_name

  • (Windows) DOMAIN_HOME\bin\stopComponent.cmd component_name

You can stop system components in any order.

Step 2: Stop the Managed Servers

To stop a WebLogic Server Managed Server, use the stopManagedWebLogic script:

  • (UNIX) DOMAIN_HOME/bin/stopManagedWebLogic.sh managed_server_name admin_url

  • (Windows) DOMAIN_HOME\bin\stopManagedWebLogic.cmd managed_server_name admin_url

When prompted, enter your user name and password.

Step 3: Stop Oracle Identity Management Components

Stop any Oracle Identity Management components, such as Oracle Internet Directory, that form part of your environment:
  • (UNIX) DOMAIN_HOME/bin/stopComponent.sh component_name

  • (Windows) DOMAIN_HOME\bin\stopComponent.cmd component_name

Step 4: Stop the Administration Server

When you stop the Administration Server, you also stop the processes running in the Administration Server, including the WebLogic Server Administration Console and Fusion Middleware Control.

To stop the Administration Server, use the stopWebLogic script:

  • (UNIX) DOMAIN_HOME/bin/stopWebLogic.sh

  • (Windows) DOMAIN_HOME\bin\stopWebLogic.cmd

When prompted, enter your user name, password, and the URL of the Administration Server.

Step 5: Stop Node Manager

To stop Node Manager, close the command shell in which it is running.

Alternatively, after having set the nodemanager.properties attribute QuitEnabled to true (the default is false), you can use WLST to connect to Node Manager and shut it down. For more information, see stopNodeManager in Oracle Fusion Middleware WLST Command Reference for WebLogic Server.

3.3 Installing Oracle GoldenGate Studio

Before beginning your upgrade, download the Oracle GoldenGate Studio 12c ( distribution on the target system and install it using Oracle Universal Installer.

To install Oracle GoldenGate Studio:
  1. Sign in to the target system where you want to install the 12c ( product distribution.
  2. Download the following 12c ( product distributions from Oracle Technology Network or Oracle Software Delivery Cloud to your target system:
    • Oracle GoldenGate Studio (fmw_12.


      In case there are two jar files, download both the files.
  3. Change to the directory where you downloaded the 12c ( product distribution.
  4. Start the installation program by entering the following command:
    (UNIX) JDK_HOME/bin/java -jar fmw_12.
    (Windows) JDK_HOME\bin\java -jar fmw_12.
  5. On UNIX operating systems, the Installation Inventory Setup screen appears if this is the first time you are installing an Oracle product on this host.
    Specify the location where you want to create your central inventory. Make sure that the operating system group name selected on this screen has write permissions to the central inventory location and click Next.


    The Installation Inventory Setup screen does not appear on Windows operating systems.
  6. On the Welcome screen, review the information to make sure that you have met all the prerequisites. Click Next.
  7. On the Auto Updates screen, select Skip Auto Updates. Options are:
    • Skip Auto Updates: If you do not want your system to check for software updates at this time.

    • Select patches from directory: To navigate to a local directory if you downloaded patch files.

    • Search My Oracle Support for Updates: To automatically download software updates if you have a My Oracle Support account. You must enter Oracle Support credentials then click Search. To configure a proxy server for the installer to access My Oracle Support, click Proxy Settings. Click Test Connection to test the connection.

    Click Next.
  8. On the Installation Location screen, specify the location for the Oracle home directory and click Next.
    For more information about Oracle Fusion Middleware directory structure, see Understanding Directories for Installation and Configuration in Oracle Fusion Middleware Planning an Installation of Oracle Fusion Middleware.
  9. On the Installation Type screen, select Complete Install and click Next.
  10. The Prerequisite Checks screen analyzes the host computer to ensure that the specific operating system prerequisites have been met.
    To view the list of tasks that gets verified, select View Successful Tasks. To view log details, select View Log. If any prerequisite check fails, then an error message appears at the bottom of the screen. Fix the error and click Rerun to try again. To ignore the error or the warning message and continue with the installation, click Skip (not recommended).
  11. On the Installation Summary screen, verify the installation options you selected.
    If you want to save these options to a response file, click Save Response File and enter the response file location and name. The response file collects and stores all the information that you have entered, and enables you to perform a silent installation (from the command line) at a later time.

    Click Install to begin the installation.

  12. On the Installation Progress screen, when the progress bar displays 100%, click Finish to dismiss the installer, or click Next to see a summary.
  13. The Installation Complete screen displays the Installation Location and the Feature Sets that are installed. Review this information and click Finish to close the installer.

3.4 Upgrading Product Schemas

After stopping servers and processes, use the Upgrade Assistant to upgrade supported product schemas to the current release of Oracle Fusion Middleware.

The Upgrade Assistant allows you to upgrade individually selected schemas or all schemas associated with a domain. The option you select determines which Upgrade Assistant screens you will use.

3.4.1 Starting the Upgrade Assistant

Run the Upgrade Assistant to upgrade product schemas, domain component configurations, or standalone system components to 12c ( Oracle recommends that you run the Upgrade Assistant as a non-SYSDBA user, completing the upgrade for one domain at a time.

To start the Upgrade Assistant:
  1. Go to the oracle_common/upgrade/bin directory:
    • (UNIX) ORACLE_HOME/oracle_common/upgrade/bin
    • (Windows) ORACLE_HOME\oracle_common\upgrade\bin
  2. Start the Upgrade Assistant:
    • (UNIX) ./ua
    • (Windows) ua.bat

For information about other parameters that you can specify on the command line, such as logging parameters, see: Upgrade Assistant Command-Line Parameters

When you start the Upgrade Assistant from the command-line, you can specify additional parameters.

Table 3-2 Upgrade Assistant Command Line Parameters

Parameter Required or Optional Description


Required for readiness checks

NOTE: Readiness checks cannot be performed on standalone installations (those not managed by the WebLogic Server).

Performs the upgrade readiness check without performing an actual upgrade.

Schemas and configurations are checked.

Do not use this parameter if you have specified the -examine parameter.



Identifies the number of threads available for concurrent schema upgrades or readiness checks of the schemas.

The value must be a positive integer in the range 1 to 8. The default is 4.


Required for silent upgrades or silent readiness checks

Runs the Upgrade Assistant using inputs saved to a response file generated from the data that is entered when the Upgrade Assistant is run in GUI mode. Using this parameter runs the the Upgrade Assistant in silent mode (without displaying Upgrade Assistant screens).



Performs the examine phase but does not perform an actual upgrade.

Do not specify this parameter if you have specified the -readiness parameter.

-logLevel attribute


Sets the logging level, specifying one of the following attributes:






The default logging level is NOTIFICATION.

Consider setting the -logLevel TRACE attribute to so that more information is logged. This is useful when troubleshooting a failed upgrade. The Upgrade Assistant's log files can become very large if -logLevel TRACE is used.

-logDir location


Sets the default location of upgrade log files and temporary files. You must specify an existing, writable directory where the Upgrade Assistant will create log files and temporary files.

The default locations are:

(UNIX) ORACLE_HOME/oracle_common/upgrade/logs

(Windows) ORACLE_HOME\oracle_common\upgrade\logs



Displays all of the command-line options.

3.4.2 Upgrading the Schemas with the Upgrade Assistant

Navigate through the screens in the Upgrade Assistant to upgrade the product schemas.

To upgrade product schemas with the Upgrade Assistant:
  1. On the Welcome screen, review an introduction to the Upgrade Assistant and information about important pre-upgrade tasks. Click Next.


    For more information about any Upgrade Assistant screen, click Help on the screen.
  2. On the Selected Schemas screen, select Individually Selected Schemas. This option allows you to select only those schemas that you want to include in the upgrade. Click Next.
  3. On the Available Components screen, select Oracle GoldenGate Studio and click Next.
  4. On the Prerequisites screen, acknowledge that the prerequisites have been met by selecting all the check boxes. Click Next.


    The Upgrade Assistant does not verify whether the prerequisites have been met.
  5. On the OGGSTUDIO Schema screen, specify the connection credentials for the repository that needs to be upgraded.
    Specify the service name and the database administrator account: DBA username and password for the database containing the OGGSTUDIO schema and click Connect.


    Do not use SYSDBA as the database user name.

  6. Specify the schema user name and the password for the selected schema.
    When you see the message “Connection to database successfully completed”, click Next.
  7. On the Studio Options screen, select Upgrade topology and security metadata and Use AES-128 encryption algorithm. Click Next.


    If you do not select Use AES-128 encryption algorithm, AES-256 encryption algorithm is used for the upgrade.

  8. On the OGG Studio Supervisor screen, specify the supervisor credentials for the OGG repository you want to upgrade and click Next.
  9. On the Examine screen, review the status of the Upgrade Assistant as it examines each schema, verifying that the schema is ready for upgrade. If the status is Examine finished, click Next.
    If the examine phase fails, Oracle recommends that you cancel the upgrade by clicking No in the Examination Failure dialog. Click View Log to see what caused the error and refer to Troubleshooting Your Upgrade in Oracle Fusion Middleware Upgrading with the Upgrade Assistant Upgrade Guide for information on resolving common upgrade errors.


    • If you resolve any issues detected during the examine phase without proceeding with the upgrade, you can start the Upgrade Assistant again without restoring from backup. However, if you proceed by clicking Yes in the Examination Failure dialog box, you need to restore your pre-upgrade environment from backup before starting the Upgrade Assistant again.

    • Canceling the examination process has no effect on the schemas or configuration data; the only consequence is that the information the Upgrade Assistant has collected must be collected again in a future upgrade session.

  10. On the Upgrade Summary screen, review the summary of the options you have selected for schema upgrade.
    Verify that the correct Source and Target Versions are listed for each schema you intend to upgrade.
    If you want to save these options to a response file to run the Upgrade Assistant again later in response (or silent) mode, click Save Response File and provide the location and name of the response file. A silent upgrade performs exactly the same function that the Upgrade Assistant performs, but you do not have to manually enter the data again.
    Click Upgrade to start the upgrade process.
  11. On the Upgrade Progress screen, monitor the status of the upgrade.


    Allow the Upgrade Assistant enough time to perform the upgrade. Do not cancel the upgrade operation unless absolutely necessary. Doing so may result in an unstable environment.
    If any schemas are not upgraded successfully, refer to the Upgrade Assistant log files for more information.


    The progress bar on this screen displays the progress of the current upgrade procedure. It does not indicate the time remaining for the upgrade.

    Click Next.

  12. If the upgrade is successful: On the Upgrade Success screen, click Close to complete the upgrade and close the wizard.

    If the upgrade fails: On the Upgrade Failure screen, click View Log to view and troubleshoot the errors. The logs are available at ORACLE_HOME/oracle_common/upgrade/logs.


    If the upgrade fails, you must restore your pre-upgrade environment from backup, fix the issues, then restart the Upgrade Assistant.

3.4.3 Verifying the Schema Upgrade

After completing all the upgrade steps, verify that the upgrade was successful by checking that the schema version in schema_version_registry has been properly updated.

If you are using an Oracle database, connect to the database as a user having Oracle DBA privileges, and run the following from SQL*Plus to get the current version numbers:


In the query result:

  • Check that the number in the VERSION column matches the latest version number for that schema. For example, verify that the schema version number is . Note, however, that not all schema versions will be updated. Some schemas do not require an upgrade to this release and will retain their pre-upgrade version number.

  • The STATUS field will be either UPGRADING or UPGRADED during the schema patching operation, and will become VALID when the operation is completed.

  • If the status appears as INVALID, the schema update failed. You should examine the logs files to determine the reason for the failure.

  • Synonym objects owned by IAU_APPEND and IAU_VIEWER will appear as INVALID, but that does not indicate a failure.

    They become invalid because the target object changes after the creation of the synonym. The synonyms objects will become valid when they are accessed. You can safely ignore these INVALID objects.