Docs‎ > ‎Install Live API Creator‎ > ‎

Install on Apache Tomcat

Verify Prerequisites


  • You have Java JDK installed. For more information:
You can check what version of Java JDK you have installed and whether you have it installed correctly by issuing the following command:
java -version

(On Windows) You have created a JAVA_HOME environment variable that has a variable value to the location of your Java JDK installation. For example, JAVA_HOME with 
C:\Program Files\Java\jdk1.8.0_77If Java is installed in a path that contains one or more spaces, use the short names of those directories for the variable value (for example, PROGRA~2 instead of Program Files). To determine the short name of a directory, issue the following command from the parent directory:
dir /x

This setting is in effect after you open a new Command window.

  • You have Tomcat installed. For more information about downloading and installing Tomcat, see the Apache Tomcat site.

Configure your Admin Database

You can use the following database management systems as your admin database with Apache Tomcat:
  • MySQL or MariaDB.

For more information:

    • About running Live API Creator in Apache Tomcat using MariaDB as an admin database, see Install JDBC Driver.
  • (Advanced Users) Apache Derby. You can run Live API Creator in Apache Tomcat using Apache Derby as your admin database instead of MySQL.

For more information about running Live API Creator in Apache Tomcat using Apache Derby as an admin database, see Apache Derby as an Admin Database.

The following instructions describe configuring MySQL as your admin database.

Use MySQL as your Admin Database


  • You have MySQL installed. For more information about downloading MySQL, link here.
  • (Recommended) You have MySQL Workbench installed. For more information about installing MySQL Workbench, see MySQL Workbench.

Configure the MySQL JDBC Driver

    1. Go to MySQL site and download the most recent version of MySQL Java connector, selecting the Platform-independent option. A file named mysql-connector-java-<version>.<format> is downloaded.
    2. Unzip this file.
    3. Copy the mysql-connector-java-<version>-bin.jar JAR file to the tomcat\apache-tomcat-<version>\lib directory.

Create the Admin DB Schema

Create a new MySQL schema (for example, liveapicreator_adm_db).
  1. In MySQL Workbench, connect to your database.
  2. Right-click the existing schema, and select Create Schema:
  3. Name your schema espresso_adm_db and then click Apply.
A new schema for the admin database is created.

Create a New MySQL User

  1. In MySQL Workbench, from the Management section, click Users and Privileges, and click Add Account.
  2. On the Login tab, enter a name for your new MySQL user using the following details, and then click Apply:
    Login Name: espresso_adm_usr
    Limit Connectivity to Hosts Matching: localhost
    Password: password!
  3. On the Schema Privileges tab, click Add Entry.
  4. Choose espresso_adm_db as the selected schema, and then click Ok.
  5. Click Select ALL to select all of the access rights, clear the GRANT OPTION access right, and then click Apply.
The new MySQL user is created and granted access rights.

Configure Tomcat

    1. Open the tomcat\apache-tomcat-<version>\conf\context.xml file and insert the following XML code within the <Context> tag, save your changes, and close the file:
      <ResourceLink global="jdbc/AdminDB" name="jdbc/AdminDB" type="javax.sql.DataSource"/>
    2. Open the tomcat\apache-tomcat-<version>\conf/server.xml file and complete the following:
      1. Insert the following XML code within the <GlobalNamingResources> tag:
        <!-- Live API Creator -->
        <Resource accessToUnderlyingConnectionAllowed="true" 
        validationQuery="select 1"/>
      2. Update the username and password to the MySQL user you created. If your MySQL does not use UTF-8 by default, the url parameter must include the characterSet=utf8 parameter.
      3. Save your changes and close the file.

Install Live API Creator

Install the Live API Creator WAR file on Tomcat.

  1. Download the CALiveAPICreator-<version>.WAR file.
  2. Move the file to the tomcat\apache-tomcat-<version>\webapps directory.
  3. Rename the WAR file as ROOT.war
Make sure that there is not a directory called ROOT in the webapps directory. If there is, either delete it or rename it.

Upgrade to a Newer Version of Live API Creator

  1. If it is running, stop your Tomcat service.
  2. In the Tomcat webapps directory, delete the ROOT.war file and the ROOT folder.
  3. Copy the new Live API Creator WAR file to ROOT.war (retain the original to recall the version number).
  4. Copy ROOT.war into the Tomcat webapps directory.
  5. Start the Tomcat service.

Start your Tomcat Service

Starting the Tomcat service deploys the Live API Creator WAR file.


  1. From Terminal, cd to Tomcat's bin directory.
  2. Issue the following command:
    Note: You can use the shutdown command to stop your Tomcat Service.
  3. If you encounter a permission error, issue the following command:
    chmod 755
  1. From a command prompt, change directory to tomcat\apache-tomcat-<version>\bin directory.
  2. Issue the following command:

The Tomcat service is started and Live API Creator is installed.

Check the Logs

Check the logs to verify that the Live API Creator WAR deployed correctly and that there are no exceptions. Using a text editor, open the tomcat\apache-tomcat-<version>\logs\catalina.out file.
Note: On Windows, the file may have a date in its name.
The following response is expected:
Start Server startup in <miliseconds> ms
Important! If you see an error and the server does not start properly, fix the error than stop and restart the server by issuing the following command:

Verify your Tomcat Installation

Verify you are running the configured Tomcat by checking the Tomcat command window. Ensure that a previous version of a Tomcat install on Windows is not set to an environmental variable that results in executing the wrong version of Tomcat. A good indicator is that there are no files in the tomcat\apache-tomcat-<version>\logs folder.

Log on to Live API Creator

For more information about logging on to Live API Creator, see Log on to Live API Creator.

Verify the Installation

Verify the installation and begin your exploration of the samples. If required, install the API Server license. For more information about installing this license, see Server License.