Installer 10.15 | Complete Installation and Upgrade Information for Software AG Products | Upgrading Software AG Products On Premises | Upgrade Developer Portal, API Gateway, API Portal, or CentraSite | Upgrade API Portal | Upgrade from 9.9 through 10.5: Prepare the Old Installation
 
Upgrade from 9.9 through 10.5: Prepare the Old Installation
1. You must have the functional privileges below to upgrade API Portal. Ask your API Portal administrator to log on to the User Management Component at http://host:port/umc, go to the user management page, click your user name, and either add you to the API Administrator group or go to the Functional Privileges tab and assign the privileges listed above to you.
*License, user, and document management
*User management configuration
*Database administration
2. Install the latest product fixes on the old API Portal, then start the old API Portal.
3. Start the old API Portal Cloud Controller.
4. If the old API Portal is installed in a clustered, high-availability setup, make sure all nodes are running and accessible to the ZooKeeper ensemble. Then register each node with the parent node by running this command:
acc> add node logical_node_name IP_address_or_host_name
[@port] user_name password
5. Run this command:
acc> startall
6. Run this command to make sure all API Portal components are running:
acc> list
7. For each tenant in the old API Portal, you will have to create a tenant in the new API Portal. List all tenants in the old API Portal by running this command:
acc> list tenants
8. Back up each old tenant’s API and related data; user data; API Portal document storage data, including all access rights; and collaboration data to a file. The file extension .acb will automatically be added to each file.
The table below explains how to back up each old tenant’s data to a file for each old product release.
Old release
Commands to Run
9.9 9.10 9.12
acc> set acc config backup.restore.tenant.app.types=UMC,ABS,ADS,ECP
acc> backup tenant tenant_name to full_path_to_backup_file
username=your_user_name password=your_password
10.1 10.3 10.4 10.5
acc> backup tenant tenant_name to full_path_to_backup_file
username=your_user_name password=your_password
9. If you created a customized view of your old API Portal, back up the view as follows:
a. Open API Portal in a browser and log on with Administrator credentials.
b. Go to the Administration page. In the Views page under the Customization section, hover over the name of the custom view and click Backup. API Portal creates a ZIP file that contains the customized view.
c. Save the ZIP file.
10. Shut down the old API Portal. If the old and new API Portal are on the same machine:
*Run this command in the old API Portal Cloud Controller:
acc> stopall
*Stop the cloud agent by going to the old_Software AG_directory/API_Portal/server/bin directory and running this command:
CloudAgentApp.{bat|sh} stop