Install the Single-User Demonstration Package

Install the Single-User Demonstration Package
lac42
You can install and run 
CA Live API Creator
 on your computer for your local development or for evaluation. Install the single-user demonstration package of 
CA Live API Creator
 that is based on Jetty (the demonstration package).
The following video demonstrates how to install the single-user demonstration package of 
CA Live API Creator
.

In this article:
 
 
3
 
 
Verify the Prerequisites for Installation
Before you install this demonstration package, ensure that you have completed the following prerequisite steps:
  • You have downloaded the demonstration package from the  trial page or you have obtained the demonstration package (the file) from your CA Technologies Sales team.
  • You have Java SE Development Kit (JDK) installed.
    For more information:
  • You have created a 
    JAVA_HOME
     environment variable and set the value to point to the JDK installation directory.
    If you have not already done this, complete the following based on your operating system:
    (Windows)
     Set the value for the 
    JAVA_HOME
     environment variable as the path to your JDK installation. If you did not change the path during installation, it is something like 
    C:\Program Files\Java\jdk1.8.0_201
    . If the path contains spaces, use the shortened path name, for example, 
    C:\PROGRA~2\Java\jdk1.8.0_201
    . Close and re-open any command line windows that you had open before you made these changes, since you cannot reload environment variables from an active command prompt. If the changes do not take effect after reopening the command window, restart Windows.
    (Mac)
     From terminal, set the 
    JAVA_HOME
     environment variable using the following command:
    export JAVA_HOME=/Library/Java/Home
  • You have at least 500 MB of free disk space.
Install the Demonstration Package
  1. Create a local directory called 
    lac
    .  
  2. Copy the demonstration package (the file) into this local directory.
  3. Unzip the file.
The demonstration package is installed.
Run 
CA Live API Creator
 
Complete the following procedures after you have installed the demonstration package.
Start API Server
  1. From Terminal or a command prompt, change directories to the location of the demonstration package by issuing the following command:
    cd lac/<your demonstration package version>
     
    Example:
     
    cd lac/CALiveAPICreator-Jetty-5.0
  2. Start API server by issuing the following command:
    (Windows)
    start.bat
    (Unix/Mac)
    sh Start.sh
API Server is started when the following message appears:
*********************************************************
LAC is started and initialized
Start your Browser at http://localhost:8080/APICreator/#/
*********************************************************
Log in to API Creator
 
Prerequisites:
 
  • You have started API Server.
  • You have decided on which port you would like 
    CA Live API Creator
     to run.
    This installation assumes that the port is 8080, but you can change it to another port.
    For more information about how to adjust the port that 
    CA Live API Creator
     runs on, see the "Adjust the Port that CA Live API Creator Runs On" section.
 
Follow these steps:
 
  1. Enter the following URL into a web browser window:
    http://localhost:<HOST_PORT>/APICreator
     
    Example:
     
    http://localhost:8080/APICreator
    The API Creator logon authentication dialog opens.
  2. Log in to API Creator as the 
    admin
     user. Complete the following fields, and then click 
    Login
    :
     
    Username
     
    The username for the initial API developer is 
    admin
    . Enter 
    admin
    .
     
    Password
     
    The password for the initial API developer is 
    Password1
    . 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 API developer user (admin).
Get Started
 
Prerequisite:
 You have installed the demonstration package and are running 
CA Live API Creator
.
For more information about how to get started using 
CA Live API Creator
, see Getting Started.
Troubleshooting
Complete the following procedures if you experience issues with installing the demonstration package or logging in to API Creator.
Adjust the Port that 
CA Live API Creator
 Runs On
If you are running an application on your machine that is already using port 8080, you can get port conflict issues. The following error message appears:
Caused by: java.net.BindException: Address already in use at sun.nio.ch.Net.bind0(Native Method)
at sun.nio.ch.Net.bind(Net.java:437)
at sun.nio.ch.Net.bind(Net.java:429)
 
Follow these steps:
 
  1. Open the (for Mac) 
    Start.sh
     or (for Windows) 
    Start.bat
     script.
  2. Alter the port number for the 
    LAC_PORT
     value, for example, to 
    8181
    , and then save your changes.
  3. When logging in to API Creator, use this port in the URL, for example:
    http://localhost:8181/
The port that 
CA Live API Creator
 runs on is adjusted.
Check the Java Version
From Terminal or a command prompt, verify your Java version by issuing the following commands:
java -version (checks that Java is installed and available)
javac -version (checks that the JDK is installed)
Optional Configuration
The following topics provide optional configuration details.
Start the Debug Service
The demonstration package includes the debug service (the Debugger).
For more information about how to start the Debugger, Debugger.
Configure External Logging
By default, 
CA Live API Creator
 saves your logs as files in the 
%JETTY_HOME%/caliveapicreator/logs
 directory. For example, 
CA Live API Creator
 saves your listener logs to the 
%JETTY_HOME%/caliveapicreator/logs/listenerlog.log
 file.
You can also create a logger for externalizing your API logs.
For more information about how to configure external logging, see External Logging.
Connect to Other Data Sources
 
CA Live API Creator
 requires the corresponding JDBC driver to the database management system (DBMS) that you use as your backend data source. You can connect to the data sources where the demonstration package includes the JDBC driver or you can connect to other backend data source by installing the JDBC driver.
 This demonstration package includes the following JDBC drivers:
 
JDBC drivers
  • MySQL JDBC driver
  • JavaDB/Apache Derby JDBC driver
  • PostgreSQL JDBC driver
  • SQL Server JDBC driver
  • Salesforce JDBC driver
  • Apache HBase JDBC driver
  • SAP NetWeaver JDBC driver
  • Apache Cassandra JDBC driver
  • CSV JDBC driver
For more information about how to install other JDBC drivers, see the documentation for that data source, for example Oracle Data Source.