Installing‎ > ‎

Upgrade Live API Creator to a Newer Version

Complete the following procedures to upgrade your current Live API Creator version to a newer version. If you are using a prior stand-alone version (Jetty) and you wish to move your work to the new system, follow these instructions. If you are using Tomcat, Amazon AWS, or other cloud services, you can import the new release and the install process will upgrade your admin database.

Important! You cannot undo the upgrade process. We recommended you follow these steps.

Before you Begin

Complete the following before you begin the upgrade process:
  1. Clear your browser cache.
  2. Completely back up all of your work (APIs, databases, admin databases).
  3. (Tomcat WAR, AWS) Install the new version of Live API Creator in a separate directory and use a new admin database name.
    Important! Do not copy a previous download of the admin database to the directory for the new version of the admin database.
  4. Ensure the new version of API Server is up and running.
    Note: Ensure you have accepted the End User License Agreement (EULA).
  5. For each of your existing APIs, disable/deactivate the Java user libraries inside your API by clearing the Used checkbox for each library, and then save your changes before exporting the API.
    For more information about disabling/deactivating Java user libraries, see Logic Libraries.
  6. Copy any used Java JAR files to the lib directory for your new version of Live API Creator.

Export the Current Repository Content

Use the following process to export the current repository content:
  1. Install the new version of Live API Creator.
    For more information about how to install Live API Creator, see Installing.
  2. Install the Admin CLI using the npm install command.
    For more information about how to install the Admin CLI, see the npm site.
  3. Log in to the existing API Server by executing the following commands:
    $lacadmin login -u <admin user name> -p <the admin password for your account> http://localhost:8080 -a <alias>
    $lacadmin use <alias>
    The Admin CLI creates an export manifest of all your current repository objects; LIBRARY, PROJECT, GATEWAY, and AUTHPROVIDER. It also creates an empty --directory <directory name> directory.
  4. List the export scripts for all user libraries, authentication providers, and APIs in the connection and export to the named directory by executing the following command:
    $lacadmin migrate exportRepos --directory <directory name>  > exportRepos[.sh | .cmd]
  5. Modify the exportRespos.sh (or, for Windows users, exportRepos.cmd) script to point to your previous version of API Server, change the admin username, password, and API Server location, and then run the script.
  6. Run the new exportRepos.sh (or, for Windows users, exportRepos.cmd) script from a command window:
    $exportRepos.sh OR c:>exportRepos.cmd
The found JavaScript user libraries, resources, authentication providers, API Gateway definitions, and APIs are listed as Admin CLI export commands to the selected directory. The current repository content is exported.

Import your JSON Files to the New Version of API Server

You can import your JavaScript user libraries, resources, authentication providers, API Gateway definitions, and APIs to the new version of API Server using one of the following methods:

  • From a command line (Admin CLI).
  • Using import commands for an API and a JavaScript user library.
    Note: With this option, you must import your authentication providers and API Gateway definitions manually.

This procedure explains how to import to the new version API Server from the Admin CLI. 

  1. Connect to the new version of the server by executing the following commands:
    $lacadmin login -u <admin user name> -p <the admin password for your account> http://localhost:8080 -a <alias for the new version of the server>
    $lacadmin use <alias for the new version of the server>
  2. (Optional) For each JavaScript user library, import your library by executing the following command:
    $lacadmin library import --file <directory name>/LIBRARY_{each JavaScript user library}.json
  3. (Optional) For each authentication provider, import your authentication provider by executing the following command:
    $lacadmin authprovider import --file <directory name>/AUTHPROVIDER_{each authentication provider}.json
  4. For each API, import your API by executing the following command:
    $lacadmin project import --file <directory name>/PROJECT_{each project}.json
    Note: Before you can use your imported API, enter your password for each data source in API Creator. For more information about modifying passwords, see Database Connectivity.
  5. (Optional) Import your API Gateway definitions by executing the following command:
    $lacadmin gateway import --file <directory name>/GATEWAYS.json

Your JavaScript user libraries, resources, authentication providers, API Gateway definitions, and APIs are imported to the new version of API Server.

More Information

Live API Creator uses the Oracle Nashorn JavaScript engine. This can require changes to how you access Java classes.

For more information:

  • About the supported JavaScript engine, see the Release Notes.
  • About how to access Java classes, including details about the syntax, see JavaScript.