Upgrade Live API Creator

If you are running Live API Creator 5.x, upgrade to the latest version of . This article explains how to upgrade.
lac53
If you are running Live API Creator 5.x
, upgrade to the latest version of 
Layer7 Live API Creator
. This article explains how to upgrade.
If you are running Live API Creator 4.x or earlier
, complete the following process:
  1. Migrate
    to Live API Creator 5.0 using the migration service.
    For more information about how to migrate to
    Layer7 Live API Creator
    5.0, see Migrate Live API Creator.
  2. Upgrade to the latest version of
    Layer7 Live API Creator
    using the steps for your installation.
Upgrade to the latest version of 
Layer7 Live API Creator
 based on your installation:
Upgrade your local development environment to a newer version
Use the following procedure if you are running the single-user demonstration package of 
Layer7 Live API Creator
 that is based on Jetty (the demonstration package) to develop locally. This procedure copies the API definitions and the API samples that are defined in the admin repository that Live API Creator 5.0 uses to the latest version of 
Layer7 Live API Creator
.
Follow these steps:
  1. Stop API Server by issuing the following command:
    (Windows)
    Stop.bat
    (Unix/Mac)
    sh Stop.sh
  2. Install the newer version of the demonstration package.
  3. Copy the admin repository from the location of the demonstration package that Live API Creator 5.0 uses to the location of the repository that is in the latest version of 
    Layer7 Live API Creator
    :
    The default location of the admin repository is
    %JETTY_HOME%/CALiveAPICreator/jetty.repository
    or it is the location that you specified using the 
    LAC_REPOSITORY_ROOT
     option when you started API Server.
    For more information about this option, see API Server Startup Options.
  4. From Terminal a command prompt, change directories to the location of the demonstration package that the latest version of 
    Layer7 Live API Creator
     uses by issuing the following command:
    cd lac/<the demonstration package version>
    For example:
    cd lac/CALiveAPICreator-Jetty-5.2.00.5
  5. Start API Server by issuing the following command:
    (Windows)
    start.bat
    (Unix/Mac)
    sh Start.sh
API Server is started. You are now running the demonstration package for the latest version of 
Layer7 Live API Creator
 for your local development.
Upgrade to a newer version installed on Apache Tomcat
Use the following procedure if you have installed 
Layer7 Live API Creator
 on Tomcat.
Before upgrading
Layer7 Live API Creator
 on Tomcat, you can optionally bootstrap
Layer7 Live API Creator
with a specific configuration for your API metadata by bundling the admin repository into the
CALiveAPICreator.war
 web application ARchive (WAR) file.
For more information, see Install on Apache Tomcat.
Follow these steps:
  1. Stop the Tomcat service by issuing the following command:
    (Mac/Unix)
    sh shutdown.sh
    (Windows)
    shutdown
  2. Create a copy of the
    ROOT.war
    file to recall the version number.
  3. Create a backup of the admin repository.
    The default location for the admin repository is
    ${CATALINA_HOME}/CALiveAPICreator.repository
    or it is the location that you specified using the 
    LAC_REPOSITORY_ROOT
     option when you started API Server.
    For more information about this option, see API Server Startup Options.
  4. Delete the 
    ${CATALINA_Home}/webapps/ROOT.war
     file directory and the 
    ${CATALINA_Home}/webapps/ROOT
     directory.
  5. Rename the 
    /development/CALiveAPICreator.war
     file to 
    ROOT.war
    .
  6. Copy the 
    ROOT.war
     file to the 
    ${CATALINA_Home}/webapps
     directory.
    API Server is at the root URL. The latest version of
    Layer7 Live API Creator
    is installed.
  7. Start the Tomcat service and specify the admin repository that Live API Creator 5.0 uses by issuing the following command with
    one
    of the following options added:
    • Set the location for the admin repository that Live API Creator 5.0 uses by adding the 
      LAC_REPOSITORY_ROOT
       option.
    • Set the location from which
      Layer7 Live API Creator
      pulls the admin repository location by adding the 
      LAC_REPOSITORY_CONFIGURATION_URL
       option.
    For more information about these options and other options that you can add when starting API Server, see API Server Startup Options.
    (Mac/Unix) Issue the following command:
    sh startup.sh
    (Windows) Issue the following command:
    startup
API Server is started. You have upgraded
Layer7 Live API Creator
 on Tomcat.
Upgrade to a newer version installed on Oracle WebLogic Server
Use the following procedure if you have installed 
Layer7 Live API Creator
 on WebLogic Server.
Before upgrading
Layer7 Live API Creator
 on WebLogic Server, you can optionally bootstrap
Layer7 Live API Creator
with a specific configuration for your API metadata by bundling the admin repository into the
CALiveAPICreator.war
 file.
For more information, see Install on Oracle WebLogic.
Prerequisite:
You have obtained the package containing the
CALiveAPICreator.war
file.
Follow these steps:
  1. Create a backup of the admin repository.
    The default location for the admin repository is
    ${HOME}/CALiveAPICreator.repository
    or it is the location that you specified using the 
    LAC_REPOSITORY_ROOT
     option when you started API Server.
  2. Using the WebLogic admin web console, install the 
    CALiveAPICreator.WAR
     file.
    For more information about how to install or upgrade WAR files using the administrative console, see the Oracle WebLogic documentation.
    The latest version of
    Layer7 Live API Creator
    is installed.
  3. Start WebLogic Server with one of the following options:
    • Set the location for the admin repository that Live API Creator 5.0 uses by adding the 
      LAC_REPOSITORY_ROOT
       option when you start API Server.
    • Set the location from which
      Layer7 Live API Creator
      pulls the admin repository location by adding the 
      LAC_REPOSITORY_CONFIGURATION_URL
       option when you start API Server.
    For more information about these options and other options that you can add when starting API Server, see API Server Startup Options.
You have upgraded
Layer7 Live API Creator
 on WebLogic Server.
Upgrade to a newer version installed on IBM WebSphere
Use the following procedure if you have installed 
Layer7 Live API Creator
 on WebSphere.
Before upgrading
Layer7 Live API Creator
 on WebSphere, you can optionally bootstrap
Layer7 Live API Creator
with a specific configuration for your API metadata by bundling the admin repository into the
CALiveAPICreator.war
 file.
For more information, see Install on IBM WebSphere.
Prerequisite:
You have obtained the package containing the
CALiveAPICreator.war
file.
Follow these steps:
  1. Create a backup of the admin repository.
    The default location for the admin repository is
    ${HOME}/CALiveAPICreator.repository
    or it is the location that you specified using the 
    LAC_REPOSITORY_ROOT
     option when you started API Server.
  2. Using the administrative console, install the 
    CALiveAPICreator<version>.WAR
     file as an application in your WebSphere server.
    For more information about how to install application files on WebSphere application server, see the IBM WebSphere documentation.
    The latest version of
    Layer7 Live API Creator
    is installed.
  3. Start WebSphere with one of the following options:
    • Set the location for the admin repository that Live API Creator 5.0 uses by adding the 
      LAC_REPOSITORY_ROOT
       option when you start API Server.
    • Set the location from which
      Layer7 Live API Creator
      pulls the admin repository location by adding the 
      LAC_REPOSITORY_CONFIGURATION_URL
       option when you start API Server.
    For more information about these options and other options that you can add when starting API Server, see API Server Startup Options.
You have upgraded
Layer7 Live API Creator
 on WebSphere.
Upgrade to a newer version installed on JBoss/WildFly
Use the following procedure if you have installed 
Layer7 Live API Creator
 on JBoss/WildFly.
Before upgrading
Layer7 Live API Creator
 on JBoss/WildFly, you can optionally bootstrap
Layer7 Live API Creator
with a specific configuration for your API metadata by bundling the admin repository into the
CALiveAPICreator.war
 file.
For more information, see Install on IBM WebSphere.
Prerequisite:
You have obtained the package containing the
CALiveAPICreator.war
file.
Follow these steps:
  1. Create a backup of the admin repository.
    The default location for the admin repository is
    ${HOME}/CALiveAPICreator.repository
    or it is the location that you specified using the 
    LAC_REPOSITORY_ROOT
     option when you started API Server.
  2. Install the 
    CALiveAPICreator.WAR
     file.
    For more information about how to install WAR files in the JBoss/WildFly Web server, see the WildFly documentation.
    The latest version of
    Layer7 Live API Creator
    is installed.
  3. Start JBoss/WildFly with one of the following options:
    • Set the location for the admin repository that Live API Creator 5.0 uses by adding the 
      LAC_REPOSITORY_ROOT
       option when you start API Server.
    • Set the location from which
      Layer7 Live API Creator
      pulls your admin repository location by adding the 
      LAC_REPOSITORY_CONFIGURATION_URL
       option when you start API Server.
    For more information about these options and other options that you can add when starting API Server, see API Server Startup Options.
You have upgraded
Layer7 Live API Creator
 on JBoss/WildFly.