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

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.

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. If you are not sure how to do it, the easiest way 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

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

org.apache.tomcat.util.buf.UDecoder.ALLOW_ENCODED_SLASH
org.apache.catalina.connector.CoyoteAdapter.ALLOW_BACKSLASH

-Dorg.apache.tomcat.util.buf.UDecoder.ALLOW_ENCODED_SLASH=true
-Dorg.apache.catalina.connector.CoyoteAdapter.ALLOW_BACKSLASH=true

Encode your URL.

For more information about how to encode your URL when you call Free SQL resources with query parameters using the syntax in 

CA Live API Creator

, see Define Free SQL Resource Types.

For an example of how to encode your URL using a tool, see URL Encode/Decode tool site.

By configuring the one of following files in your Tomcat Java container:

 The file that you configure is dependent on your Tomcat version.

The 

server.xml

 file. The following example configures Tomcat to accept the |{ and } special characters in the URL requests it receives:

<Connector port="8080" protocol="HTTP/1.1" connectionTimeout="20000" redirectPort="8443" relaxedQueryChars="|{}"/>

The 

${CATALINA_HOME}/conf/catalina.properties

 file. The following example configures Tomcat to accept the |{ and } special characters in the URL requests it receives:

tomcat.util.http.parser.HttpParser.requestTargetAllow=|{}

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.

Open the 
conf/web.xml
 file.
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>
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>
For more information about the options for the HTTP Header Security filter, see the Tomcat documentation.
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.

 Bypass the extra step at login to accept the End User License Agreement (EULA).
 Specify an alternate license file.
 Change the password for the system administrator user and for the Initial API developer.
 Specify the location from where you want Live API Creator to pull your admin repository.
 Specify the location to where you want Live API Creator to add your admin repository.

-Dca_accept_license=ENU

<...Tomcat startup...> -DLAC_DEFAULT_LICENSE_FILE=/Users/jdoe/License.txt

About how to change the sa password, see Manage the System Administrator User Password.
About how to change the initial API developer password, see Manage TeamSpace Users.

<...Tomcat startup...> -DLAC_REPOSITORY_ROOT=${HOME}/CALiveAPICreator.repository

From Terminal or a command prompt, navigate to the 

${CATALINA_HOME}/bin

 directory.

Follow the steps based on your operating system:

 

(Mac/Unix)

 Do the following:

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 as a Java system property or as an environment variable.

You can stop your Tomcat Service using the 

shutdown

 command.

If you encounter a permission error, issue the following command: 

chmod 755 catalina.sh

 

(Windows)

 Do the following:

From a command prompt, change directory to

${CATALINA_HOME}

\bin

 directory.

Issue the following command:

startup

http://localhost:8080/DataExplorer

You have configured 
CA Live API Creator
 to run as a single node.
You are running in a local development environment.
You have specified an authentication provider that uses the 
Default Auth Provider
 authentication method (for example, the 
built-in authentication
 authentication provider) or a custom JavaScript authentication provider that uses the 
JavaScript Auth Provider
 authentication method as the authentication provider for your API.