Oracle® Fusion Middleware
Part 3. Upgrade and migration

This topic describes how to upgrade an existing 11.1.1.x installation of API Gateway to version 11.1.2.3.0. API Gateway 11.1.2.3.0 provides a sysupgrade script to export your data from an existing installation, upgrade it, and import it into a new API Gateway 11.1.2.3.0 installation.

This section describes the steps involved in an upgrade from version 11.1.1.x (old installation) to version 11.1.2.3.0 (new installation).

Install API Gateway 11.1.2.3.0

Install API Gateway 11.1.2.3.0 in a different directory to your old 11.1.1.x installation on all nodes. For example, if the old installation is installed in OLD_INSTALL_DIR, you should install the new installation in NEW_INSTALL_DIR. For more information on installation, see the Installation topic.

	Note
	Do not overwrite the old installation. Do not create or start any Node Managers, groups, or API Gateways. Do not shut down the old system.

NEW_INSTALL_DIR\apigateway\upgrade

NEW_INSTALL_DIR/apigateway/upgrade

OLD_INSTALL_DIR\apigateway\upgrade

OLD_INSTALL_DIR/apigateway/upgrade

Export data from the old installation

	Note
	Before you export, ensure that the Node Managers and API Gateways are running on the old installation.

Perform these steps to export the data from your old installation:

1. Open a command prompt at the following directory in your old installation:

   Windows

   OLD_INSTALL_DIR\apigateway\Win32\bin

   UNIX/Linux

   OLD_INSTALL_DIR/apigateway/posix/bin

2. Delete the out directory if it already exists.

3. Run the sysupgrade command to export the data.

   Windows

   sysupgrade export

   UNIX/Linux

   ./sysupgrade export

   The data is exported to the out directory.

4. Repeat on each node of the old installation.

OLD_INSTALL_DIR\apigateway\Win32\bin\out

OLD_INSTALL_DIR/apigateway/posix/bin/out

NEW_INSTALL_DIR\apigateway\Win32\bin\out

NEW_INSTALL_DIR/apigateway/posix/bin/out

Apply the upgrade

	Note
	You must shut down any Node Managers or API Gateways on the old installation before applying the upgrade.

Perform these steps to apply the upgraded data to your new 11.1.2.3.0 installation:

1. Open a command prompt at the following directory in your new 11.1.2.3.0 installation:

   Windows

   NEW_INSTALL_DIR\apigateway\Win32\bin

   UNIX/Linux

   NEW_INSTALL_DIR/apigateway/posix/bin

2. Run the sysupgrade command to apply the upgrades in the out directory.

   Windows

   sysupgrade apply

   UNIX/Linux

   ./sysupgrade apply

   The upgrades are applied to the new 11.1.2.3.0 installation.

3. Repeat on each node of the new installation.

The following additional steps might be required, depending on your configuration:

	Important
	You must upgrade version 11.1.1.6.x database schemas to 11.1.2.x for API Gateway to function correctly. Database schema upgrades are not supported for versions earlier than 11.1.1.6.x. If your existing API Gateway installation is version 11.1.2.x, you do not need to upgrade the database tables.

The dbsetup utility always checks the existing version, and modifies only if an update is required. For example, to start an interactive upgrade, run this script as follows:

> dbsetup.bat
Connecting to configuration at: federated:file:///INSTALL_DIR\oaganalytics/conf/fed/
configs.xml

Using Configured Database:
DB Name: Default Database Connection
DB URL: jdbc:mysql://127.0.0.1:3306/reports
DB User: root
Current schema version: 000-initial
Latest schema version: 001-topology
Continue with upgrade (Y, N) [N]: y
Schema successfully upgraded to: 001-topology

The dbsetup utility uses SQL upgrade scripts located in the following directory:

INSTALL_DIR/system/conf/sql/upgrade

The subdirectories are named for the upgrade applied, and the order in which they must be executed. The following upgrades are currently available:

To upgrade API Gateway Analytics, run the upgradeconfig script from the following location:

Windows

INSTALL_DIR\oaganalytics\Win32\bin

UNIX/Linux

INSTALL_DIR/oaganalytics/posix/bin

For more details on running this script, see the version 11.1.2.2.1 API Gateway Installation and Configuration Guide.

	Note
	This step is normally not required unless you have made significant changes to the configuration of an existing installation of API Gateway Analytics (for example, for RBAC).

If you are upgrading from version 11.1.1.6.x, you must reconfigure your RBAC settings and migrate your existing users using the following sample script:

INSTALL_DIR/samples/migrate/pdMigrate.py

This script extracts the existing users from the pdEntities.xml file in the old installation and places them in a adminUsers.json file in the new installation.

For more details on running this script, see the version 11.1.2.2.1 API Gateway Installation and Configuration Guide.

For more details on RBAC, see the Oracle API Gateway Administrator Guide.