Install on Apache Tomcat

Install on Apache Tomcat
calac41
You can install 
CA Live API Creator
 on Apache Tomcat Web server as an installable web application ARchive (WAR). This article includes information about how to install 
CA Live API Creator
 on a local machine running Apache Tomcat.
Use the following process to install 
CA Live API Creator
 on Apache Tomcat Web server:
 
 
3
 
 
Verify the Prerequisites
Before you install 
CA Live API Creator
 on Tomcat Web server, ensure that you have completed the following prerequisite steps:
  • You have installed Tomcat.
    For more information about how to download and install Tomcat, see the Apache Tomcat website.
  • You have installed Java JDK.
    For more information:
  • (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_92
     . If 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
     ).
    This setting is in effect after you open a new Command window.
  • You have reviewed the installation best practices.
    For more information about the best practices, see Installation Best Practices.
Configure your Admin Database
CA Live API Creator
 requires the corresponding JDBC driver to the database management system (DBMS) you use as your admin database.
Prerequisite:
 Your Tomcat service is stopped.
You can run 
CA Live API Creator
 in Apache Tomcat using the following DBMSs:
  •  
    Use MySQL (or MariaDB) as Your Admin Database
    You can access a database using the MySQL JDBC driver or the MariaDB JDBC driver. The MariaDB JDBC driver is compatible with MySQL. Add the MariaDB JDBC driver to avoid optimistic locking failures. Complete the following procedures based on the driver type you want to use.
    For more information about MariaDB, see the MariaDB site.
    Verify the Prerequisites
    Before you use MySQL (or MariaDB) as your admin database, ensure that you have completed the following prerequisite steps:
    • You have MySQL installed.
      For more information about how to download MySQL, see the MySQL download site.
    • (Recommended) You have MySQL Workbench installed.
      For more information about how to install MySQL Workbench, see MySQL Workbench.
    Add the MySQL (or MariaDB) JDBC Driver
    Add the MySQL or the MariaDB JDBC driver to the 
    ${CATALINA_HOME}/lib
     directory.
    The MariaDB driver is available from Installation Requirements and Supported Platforms.
    Create the Admin DB Schema
    Create a MySQL schema for your admin database. In this example, the MySQL schema is named 
    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 
      liveapicreator_adm_db
       and then click 
      Apply
      .
    The 
    liveapicreator_adm_db
     MySQL schema for your admin database is created.
    Create a MySQL User
    1. In MySQL Workbench, from the Management section, click 
      Users and Privileges
      , and click 
      Add Account
      .
    2. Go to the Login tab, enter a name for your new MySQL user using the following details, and then click 
      Apply
      :
      Login Name
       
      Enter 
      lac_dbadm
      .
      Limit Connectivity to Hosts Matching
       
      (If you plan to run Tomcat on the same machine as MySQL) Enter 
      localhost
      .
      Password
       
      Enter 
      password!
      .
    3. Go to the Schema Privileges tab and click 
      Add Entry
      .
    4. Select 
      liveapicreator_adm_db
       as the selected schema, and then click 
      Ok
      .
    5. Click 
      Select ALL
       to select all the access rights, clear the 
      GRANT OPTION
       access right, and then click 
      Apply
      .
    The 
    lac_dbadmn
     MySQL user is created and granted access rights to the 
    liveapicreator_adm_db
     MySQL schema.
    Configure Tomcat based on the DBMS you use as your admin database
    Complete the steps for one of the following:
    •  
      Configure Tomcat for MySQL
      Configure the Tomcat container with JNDI settings and server data source configuration.
      1. Open the 
        ${CATALINA_HOME}/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 
        ${CATALINA_HOME}/conf/server.xml
         file and complete the following steps:
        1. Insert the following XML code within the 
          <GlobalNamingResources>
           tag:
          <!--
          CA Live API Creator
          --> <Resource accessToUnderlyingConnectionAllowed="true" auth="Container" defaultAutoCommit="false" driverClassName="com.mysql.jdbc.Driver" initialSize="5" logAbandoned="true" maxTotal="200" maxIdle="10" maxWaitMillis="30000" minIdle="5" name="jdbc/AdminDB" password="password!" removeAbandonedOnMaintenance="true" removeAbandonedTimeout="30" type="javax.sql.DataSource" url="jdbc:mysql://localhost:3306/liveapicreator_adm_db?characterEncoding=utf8" username="lac_dbadm" validationQuery="select 1"/>
        2. Update the username and password to the MySQL user that you created, and change the url property to point to your MySQL installation.
        3. If your MySQL does not use UTF-8 by default, add the characterEncoding=utf8 parameter to the url parameter.
        4. Save your changes and close the file.
      The MySQL JDBC driver is configured.
    •  
      Configure Tomcat for MariaDB
      1. Open the 
        ${CATALINA_HOME}/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 
        ${CATALINA_HOME}/conf/server.xml
         file and complete the following steps:
        1. Insert the following XML code within the 
          <
           
          GlobalNamingResources
           
          >
           tag:
          <Resource accessToUnderlyingConnectionAllowed="true"
          auth="Container"
          defaultAutoCommit="false"
          driverClassName="org.mariadb.jdbc.Driver"
          initialSize="5"
          logAbandoned="true"
          maxTotal="200"
          maxIdle="10"
          maxWait="30000"
          minIdle="5"
          name="jdbc/AdminDB"
          password="
          password!
          "
          removeAbandoned="true"
          removeAbandonedTimeout="30"
          type="javax.sql.DataSource"
          url="jdbc:mariadb://localhost:3306/
          liveapicreator_adm_db
          ?characterEncoding=utf8"
          username="
          lac_dbadm
          "
          validationQuery="select 1"/>
        2. Update the username and password to the MariaDB user that you created, and change the url property to point to your MySQL installation.
        3. On systems that are not set to UTC, modify the MySQL connection string to work around timestamp issues.
        4. If your MariaDB does not use UTF-8 by default, add the 
          characterEncoding=utf8
           parameter to the 
          url
           parameter.
        5. Save your changes and close the file.
      The MariaDB JDBC driver is configured.
  •  
    Use PostgreSQL as your Admin Database
    If you use a PostgreSQL version prior to 9.4, you cannot specify the schema. The admin data goes into the public schema.
    PostgreSQL functions are not exposed as REST endpoints in 
    CA Live API Creator
    . This PostgreSQL JDBC driver limitation exposes inadequate information on the parameter datatypes to 
    CA Live API Creator
    .
    For more information about the versions of PostgreSQL as an admin database and PostgreSQL JDBC drivers that 
    CA Live API Creator
     supports, see Installation Requirements and Supported Platforms.
    Complete the following to use PostgreSQL as your admin database.
    Verify the Prerequisite
    Before you use PostgreSQL as your admin database, ensure that you have installed a PostgreSQL server and it is running.
    Add the PostgreSQL JDBC Driver
    Add the PostgreSQL JDBC driver to the 
    ${CATALINA_HOME}/lib
     directory.
    Create the Admin DB SchemaFor more information about how to add the driver, see the PostgreSQL site.
    Create a schema in your PostgreSQL database. You can name your schema anything that you want, for example, 
    lacadmin
    .
    Create a PostgreSQL User
    Create a user in your PostgreSQL database (for example 
    lacuser
    ) and ensure that user has full privileges to the schema you created.
    Configure Tomcat for PostgreSQL
    1. Open the 
      ${CATALINA_HOME}/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 
      ${CATALINA_HOME}/conf/server.xml
       file and insert the following code in the 
      <GlobalNamingResources>
       tag:
      <Resource accessToUnderlyingConnectionAllowed="true"
      auth="Container"
      defaultAutoCommit="false"
      driverClassName="org.postgresql.Driver"
      initialSize="10"
      logAbandoned="true"
      maxIdle="0"
      maxTotal="200"
      maxWaitMillis="15000"
      minIdle="0"
      name="jdbc/AdminDB"
      password="
      secret
      "
      removeAbandonedOnMaintenance="true"
      removeAbandonedTimeout="30"
      timeBetweenEvictionRunsMillis="30000"
      type="javax.sql.DataSource"
      url="jdbc:postgresql://mypostgres:5432/
      postgres
      ?currentSchema=
      lacadmin
      &amp;characterEncoding=utf8"
      username="
      lacuser
      "
      validationQuery="select 1"/>
      The PostgreSQL JDBC driver is configured.
  •  
    Use Oracle as your Admin Database
    Complete the following to use Oracle as your admin database.
    Verify the Prerequisite
    Before you use Oracle as your admin database, ensure that you have installed an Oracle server and it is running.
    Add the Oracle JDBC Driver
    Add the Oracle JDBC driver to the 
    ${CATALINA_HOME}/lib
     directory.
    For more information about how to add the driver, see the Oracle site.
    Create an Oracle User
    Create an user in your Oracle database (for example 
    lacuser
    ) and ensure that that user has full privileges to create tables, columns, and indexes.
    Configure Tomcat for Oracle
    Open the 
    ${CATALINA_HOME}/conf/server.xml
     file and insert the following XML code within the 
    <GlobalNamingResources>
     tag, save your changes, and close the file:
    <Resource accessToUnderlyingConnectionAllowed="true"
    auth="Container"
    defaultAutoCommit="false"
    driverClassName="oracle.jdbc.OracleDriver"
    initialSize="10"
    logAbandoned="true"
    maxIdle="0"
    maxTotal="200"
    maxWaitMillis="15000"
    minIdle="0"
    name="jdbc/AdminDB"
    password="Password!"
    removeAbandonedOnMaintenance="true"
    removeAbandonedTimeout="30"
    timeBetweenEvictionRunsMillis="30000"
    type="javax.sql.DataSource"
    url="jdbc:oracle:thin:@localhost:1521:xe"
    username="&quot;lacuser&quot;"
    validationQuery="select 1 from dual"/>
  • Use Microsoft SQL Server as your Admin Database
    Complete the following to use SQL Server as your admin database.
    Verify the Prerequisite
    Before you use SQL Server as your admin database, ensure that you have installed a SQL Server server and it is running.
    Add the SQL Server JDBC Driver
    Add the JAR file (the JDBC driver) to the 
    ${CATALINA_HOME}/lib
     directory.
    Create the Admin DB Schema
    Create a schema in your SQL Server  database. You can call it anything that you want, for example, 
    lacadmin
    .
    Create a SQL Server User
    Create a user in your SQL Server  database (for example 
    lacuser
    ) and ensure that user has full privileges to the schema you created.
    Configure Tomcat for SQL Server 
    1. Open the 
      ${CATALINA_HOME}/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 
      ${CATALINA_HOME}/conf/server.xml
       file and insert the following code in the 
      <GlobalNamingResources>
       tag:
      <Resource accessToUnderlyingConnectionAllowed="true"
      auth="Container"
      defaultAutoCommit="false"
      driverClassName="com.microsoft.sqlserver.jdbc.SQLServerDriver"
      initialSize="10"
      logAbandoned="true"
      maxIdle="0"
      maxTotal="200"
      maxWaitMillis="15000"
      minIdle="0"
      name="jdbc/AdminDB"
      password="Password!"
      removeAbandonedOnMaintenance="true"
      removeAbandonedTimeout="30"
      timeBetweenEvictionRunsMillis="30000"
      type="javax.sql.DataSource"
      username="dblocal_admin"
      validationQuery="select 1 "/>
    The SQL Server JDBC driver is configured.
  •  
    (Advanced Users) Use Apache Derby as your Admin Database
    Complete the following to use Apache Derby as your admin database.
    • Derby as an admin database is supported only for demonstration and proof of concept (POC) purposes. Using Derby as your admin database limits your ability to upgrade to the next 
      CA Live API Creator
       release.
    • Using Derby as your admin database is for advanced users.
    • Limitations:
       
      CA Live API Creator
       supports Derby only in embedded mode. In this mode, Apache Derby does not support cluster configurations. Only one server can access the database at any given time.
    Verify Prerequisites
    Before you use Derby as your admin database, ensure that the 
    derby-<version>.jar
     JAR file is in the 
    ${CATALINA_HOME}/lib
     directory.
    Configure Derby
    Open the 
    ${CATALINA_HOME}/conf/server.xml
     file, insert the following XML code within the 
    <GlobalNamingResources>
     tag, save your changes, and close the file:
    <Resource accessToUnderlyingConnectionAllowed="true" auth="Container" defaultAutoCommit="false" driverClassName="org.apache.derby.jdbc.EmbeddedDriver" initialSize="0" logAbandoned="true" maxActive="200" maxIdle="0" maxWait="15000" minIdle="0" name="jdbc/AdminDB" removeAbandoned="true" removeAbandonedTimeout="30" timeBetweenEvictionRunsMillis="30000" type="javax.sql.DataSource" url="jdbc:derby:/Users/jdoe/CALiveAPICreatorAdmin;create=true" username="CALiveAPICreatorAdmin"/>
    The 
    url
     parameter must point to the directory for an existing admin database or to a non-existing directory which you will create. You can specify any path in the URL. On Windows, you can specify a drive, for example:
    jdbc:derby:d:\Users\jdoe\CALiveAPICreator;create=true
    The 
    create=true
     parameter creates a database directory if one does not exist. Creating a database directory is typically desirable, at least for the first time.
    For more information about the JavaDB URL, see the Development Guide on the Apache.org site.
    If you have a port conflict with the default 8080 port, open the 
    start.ini
     file in the home folder and change the following snippet:
    ## Connector port to listen on jetty.http.port=8080
Install 
CA Live API Creator
 on Tomcat
Prerequisite:
 A directory called 
ROOT
 in the 
${CATALINA_HOME}/webapps
 directory does not exist. If this directory exists, delete or rename it.
You can install all the 
CA Live API Creator
 components—API Creator, API Server, and Data Explorer—simultaneously or (if you are an advanced user and you want greater flexibility) each of the components individually. Use the WAR files that are included in the 
CA Live API Creator
 installation zip file.
Install all the components simultaneously using the 
/development
 
CALiveAPICreator.war
 file.
  1. Retrieve the 
    CALiveAPICreator.war
     file from your 
    CA Live API Creator
     installation bundle and copy it to the 
    ${CATALINA_HOME}/webapps
     directory.
  2. (If you want 
    CA Live API Creator
     to be at the root URL) Rename the 
    CALiveAPICreator.war
     file to 
    ${CATALINA_HOME}/webapps/ROOT.war
    .
Install an individual 
CA Live API Creator
 component using the WAR file pertaining to that component. These files are located in the 
/production
 directory.
  1. Retrieve the WAR file for the component that you want to install from your 
    CA Live API Creator
     bundle and copy it to the 
    ${CATALINA_HOME}/webapps
     directory:
    •  
      APICreator.war
      , which installs API Creator.
    •  
      APIServer.war
      , which installs API Server.
    •  
      DataExplorer.war
      , which installs Data Explorer.
     You can copy one or more component WAR files into the 
    ${CATALINA_HOME}/webapps
     directory. 
  2. (If you want API Server to be at the root URL) Rename the 
    APIServer.war
     file to 
    ROOT.war
     .
(Optional) Verify your Installation
  1. Verify that 
    CA Live API Creator
     installed correctly and that there are no exceptions by checking the logs. Using a text editor, open the 
    ${CATALINA_HOME}>
    /
    logs/catalina.out
     file.
     On Windows, the file might have a date in its name.
    The following response is expected:
    Start Server startup in <miliseconds> ms
    If you see an error and the server does not start properly, fix the error then stop and restart the server by issuing the following commands:
    (Windows)
    shutdown startup
    (Unix/Mac)
    sh shutdown.sh sh startup.sh
  2. Verify that you are running the configured Tomcat by checking the Tomcat command window. A wrong version of Tomcat can execute. Ensure that a previous version of a Tomcat install on Windows is not set to an environmental variable. A good indicator is that there are no files in the 
    ${CATALINA_HOME}/logs
     folder.
    If WARNING messages from the
    StandardJarScanner
    appear, you can safely ignore them. These messages are not errors.
Optional Configuration
The following topics provide optional configuration details.
Configure Tomcat for the Northwind Sample Database
Complete the following if you want to allow application developers who will use 
CA Live API Creator
 to use the Northwind sample database.
Prerequisite:
 The Northwind sample database is a Derby data source. Ensure that the correct version of the JavaDB/Apache Derby JDBC driver is in the 
${CATALINA_HOME}/lib
 directory. For more information about the version of JavaDB/Apache Derby JDBC driver that 
CA Live API Creator
 supports, see Installation Requirements and Supported Platforms.
Follow these steps:
 
  1. Copy the 
    <
    CA Live API Creator
     
     
     download package>
     
    Samples/databases/Northwind.zip
     file to a directory on the same machine as Tomcat by issuing the following commands:
     In this example, the location is 
    /opt/ca/sampleDBs
    .
    cp Northwind.zip /opt/CA/lac/sampleDBs
    cd /opt/ca/sampleDBs
  2. Unzip the copied zip file into the 
    Northwind
     directory by issuing the following command:
    unzip -d Northwind Northwind.zip
    The new 
    Northwind
     (the case is important) directory now contains a few files and directories such as 
    log
    seg0
    , etc. We recommend that you keep the zip file in this location so that you can easily restore the Northwind database to a pristine state.
  3. Instruct Tomcat to use the 
    /opt/ca/sampleDBs
     directory as the default Derby directory by setting the 
    derby.system.home
     system property to the 
    /opt/ca/sampleDBs
    .
    There are many ways to change the value for this system property. One method is to set an environment variable before starting Tomcat by issuing the following command:
    export CATALINA_OPTS=-Dderby.system.home="/opt/ca/sampleDBs"
    ./startup.sh
The Northwind sample database is installed.
Speed Up Tomcat
You can speed up Tomcat startup time, sometimes significantly, by specifying which JAR files Tomcat should not scan for configuration information when you use the 
JarScanner
 functionality. On a basic Tomcat install, skipping unneeded JARs can reduce Tomcat's startup time from 40 seconds to 4 seconds and prevents warnings.
Follow these steps:
 
  1. Edit the 
    ${CATALINA_HOME}/conf/catalina.properties
     file.
  2. Add the following JARs to the 
    tomcat.util.scan.StandardJarScanFilter.jarsToSkip
     JAR scanning property:
    cdata*.jar,db2*.jar,derby*.jar,mariadb*.jar,mongo*.jar,mysql*.jar,\
    ojdbc*.jar,postgres*.jar,sqljdbc*.jar,\
    guava*.jar,mchange*.jar,mvel*.jar,quartz*.jar,shiro*.jar,slf4j*.jar,\
    kafka*.jar,org.eclipse.paho.client*.jar,ecj*.jar,el-api.jar
Configure 
CA Live API Creator
 to Access URLs That Contain Special Characters
If your database contains binary primary keys, you can access certain URLs that contain special characters (such as slash) by setting the following configuration parameters to 
true
 in your Tomcat installation:
  •  
    org.apache.tomcat.util.buf.UDecoder.ALLOW_ENCODED_SLASH
     
  •  
    org.apache.catalina.connector.CoyoteAdapter.ALLOW_BACKSLASH
     
You can add these configuration parameters to your Tomcat's startup script using the following options:
-Dorg.apache.tomcat.util.buf.UDecoder.ALLOW_ENCODED_SLASH=true
-Dorg.apache.catalina.connector.CoyoteAdapter.ALLOW_BACKSLASH=true
Allow Multipart/Form-Data Requests to be Parsed Automatically
You can allow multipart/form-data requests to be parsed even when the target servlet does not specify 
@MultipartConfig
 or have a 
<multipart-config>
 element.
Follow these steps:
 
  1. Open the 
    ${CATALINA_HOME}/conf/context.xml
     file and insert the following XML code within the 
    <Context>
     tag:
    allowCasualMultipartParsing="true"
  2. Save your changes, and then close the file.
You have allowed multipart/form-data requests to be parsed.
Configure Offline Viewing of API Server Logs
You can create a logger for externalizing your API logs.
For more about how to configure offline viewing of API Server logs, see External Logging.
Minimize Security Vulnerabilities by Enabling HTTP Security Headers
You can minimize security vulnerabilities on 
CA Live API Creator
 applications, such as API Creator and Data Explorer, which are web-based applications, by adding security headers to Tomcat. HTTP security headers give browsers explicit instructions about how to communicate with a website. 
You can minimize security vulnerabilities on 
CA Live API Creator
 applications at one of the following levels: 
  • At the Java-container level, within Tomcat.
  • At the 
    CA Live API Creator
     application-level, within the 
    WEB-INF/web.xml
     file that is in the 
    /development/CALiveAPICreator.war
     file. The 
    WEB-INF/web.xml
     file contains the web application deployment descriptor for your application.
The following procedure details how to minimize security vulnerabilities on 
CA Live API Creator
 applications within Tomcat.
Follow these steps:
 
  1. Open the 
    conf/web.xml
     file.
  2. Instruct Tomcat to support the HTTP Header Security filter by uncommenting the following section:
    <filter>
    <filter-name>httpHeaderSecurity</filter-name>
    <filter-class>org.apache.catalina.filters.HttpHeaderSecurityFilter</filter-class>
    <async-supported>true</async-supported>
    </filter>
  3. Add the following section to the file, customizing the URL for API Creator and Data Explorer:
    <filter-mapping>
    <filter-name>httpHeaderSecurity</filter-name>
    <url-pattern>/
    APICreator/*
    </url-pattern>
    <url-pattern>/
    DataExplorer/*
    </url-pattern>
    </filter-mapping>
    This configuration ensures that the REST calls that API Server facilitates are not affected with these security headers that would add overhead to the REST responses.
You have protected 
CA Live API Creator
 applications at the Java-container level.
Next Steps
Complete the following procedures after you have installed 
CA Live API Creator
 on Tomcat.
Change the Password for the System Administrator User
You must change the password for the system administrator (
sa
) user. You can do this before you start your Tomcat service or you can add the 
LAC_INITIAL_SA_PASSWORD
 option when you start API Server.
For more information about this option, see Common Installation Options.
Enable Other Options at Startup
Before starting Tomcat, the following are options that you can add to the Java command line when you start API Server:
 Specify these options only once. Do not specify these options as part of normal operations.
For more information about these options, see Common Installation Options.
Bypass the Extra Step at Login to Accept the EULA at startup
If you are deploying into production using a cluster or if you are scripting deployment, you can bypass the API Creator screen that asks the initial TeamSpace user to log in to accept the user license, which pre-accepts the terms of the End User License Agreement (EULA). You can pre-accept the terms of the EULA by adding the 
ca_accept_license
 option when you start API Server, for example:
-Dca_accept_license=ENU
Specify an Alternate License File at Container Startup
The first time that you start Tomcat with 
CA Live API Creator
, you must install the API Server license file. You can install this file when you start your Tomcat service by adding the 
LAC_DEFAULT_LICENSE_FILE
 option when you start API Server, for example:
<...Tomcat startup...> -DLAC_DEFAULT_LICENSE_FILE=/Users/jdoe/License.txt
Start your Tomcat Service
  1. From Terminal, 
    cd
     to Tomcat's 
    bin
     directory.
  2. Follow the steps based on your operating system:
    • (Mac/Unix) 
      Do the following:
      1. Issue the following command:
        sh startup.sh
        The first time that you start Tomcat with 
        CA Live API Creator
        , you must install your license file. You can install your license file by adding the option when you start API Server.
        You can stop your Tomcat Service using the 
        shutdown
         command.
      2. If you encounter a permission error, issue the following command:
        chmod 755 catalina.sh
    • (Windows)
       Do the following:
      1. From a command prompt, change directory to 
        ${CATALINA_HOME}/
         
        bin
         directory.
      2. Issue the following command:
        startup
The Tomcat service is started and 
CA Live API Creator
 is installed.
Log in to 
CA Live API Creator
 
You can access the 
CA Live API Creator
 component WARs that you have copied to the 
${CATALINA_HOME}/webapps
 directory using a URL that includes the WAR file's name. For example, if you have copied the 
DataExplorer.war
 file into this directory, you can access Data Explorer using the following URL:
Follow these steps:
 
  1. Enter the following URL into a browser window:
    The API Creator logon authentication dialog opens.
  2. Complete the following fields, and then click 
    Login
    :
    Server
     
    The URL and location of API Server, which can include the root web application archive (WAR) file's name.
    Example: 
    /APIServer
     The server location and name depends on the type of installation and configuration of your API.
     
    Username
     
    The username for the initial API developer that 
    CA Live API Creator
     creates when you install 
    CA Live API Creator
    , which is 
    admin
     . Enter 
    admin
     .
     
    Password
     
    The password for the initial API developer. Enter 
    Password1
     .
  3. If this is your first time logging in to API Creator, accept the terms of the End User License Agreement (EULA). You must accept these terms before you can use API Creator.
You are logged in to API Creator as the administrator user (admin).
Import the API Server License
If you did not specify a license file when starting Tomcat, you must now upload it.
For more information about how to upload the license in API Creator, see Import the API Server License.
Install the Admin CLI
If you want to manage your 
CA Live API Creator
 installation from the command line or using scripts, install the Admin command-line interface (CLI) and its dependencies (Node.js). With the Admin CLI and Node.js installed, you can manage your admin services, such as migrating APIs–including your JavaScript user libraries, resources, authentication providers, API Gateway definitions–to a newer version of API Server.
 For more information:
Begin your Exploration of the API Samples
For more information about these samples, see API Samples.
Advanced Configuration
The following topics provide advanced configuration details.
Configure 
CA Live API Creator
 to Run as a Cluster
You can run 
CA Live API Creator
 as a cluster within multiple nodes for scalability and increased performance.
For more information about how to configure 
CA Live API Creator
 to run as a cluster, see Configure Live API Creator to Run as a Cluster.
Configure your Admin Database for High Availability
Most databases offer High Availability (HA) configuration options. If you require that your admin database run with HA, use the HA solution that your database supports. For example, some databases might require that you specify a different JDBC connection URL.
For more information:
  • About the HA solutions your database supports, see the documentation for your database.
  • About how to configure the JDBC connection URL to connect to databases that are configured for HA, see the documentation for your database JDBC driver.