Product

FootPrints

Component

Footprints Rewrite in Java - Renoir

Applies to

FootPrints 12.1.X - 20.XX

Question

How do I configure Tomcat for FootPrints 12.X - 20.X on Windows?

Answer

Link to Youtube BMC Channel video here

The Apache Tomcat is the only supported Web Server (Servlet Container) that can host the FootPrints application server. For performance considerations, the use of a dedicated Tomcat instance is recommended.

The following Apache Tomcat versions are supported.

FootPrints Version	FootPrints Version
FootPrints 12.1.x and 20.18.02	Apache Tomcat Version 7.0.x (64-bit)
FootPrints 20.18.03 , 20.19.X, 20.20.X, 20.21.X	Apache Tomcat Version 8.5.x (64-bit)
Footprints 20.21.02 or later	Apache Tomcat version 8.5.X and 9.X

Prerequisites

1. Install and configure Java for usage in Footprints ( Knowledge Base )

FootPrints Version	Java Version
Footprints 20.21.02 or later	OpenJDK 17
FootPrints 20.19.03 ,20.20.X, 20.21.01	OpenJDK 12.0.2 & 13.0.2
FootPrints 20.19.02	OpenJDK 12.0.2
FootPrints 20.19.01	OpenJDK 11.0.2
FootPrints 12.1.x and 20.18.03	Java 8 (64-bit)

2. Tomcat service must be configured to use Local System service account

Click Start, point to Administrative Tools, and then click Services.
Right-click on Apache Tomcat service, and then click Properties.
Click the Log On tab, select the Local system radio button, and then click Apply.
Click the General tab, and then click Start to restart the service.

3. Configure Java Virtual Machine (JVM) Memory Setting up

The below-mentioned configuration tool is located under ..\Tomcat 8.5\bin\Tomcat8w.exe

You should add the options and the values below as they are set to depend on your version of Java and the application server that you use.

Note# Please remove --illegal-access=permit from Java 9 Options after 20.21.02

FootPrints Version	Java Options	Java 9 Options
Footprints 20.21.02.001 - 20.24.01.002	-Dfile.encoding=UTF-8 -XX:+UseG1GC -XX:MaxHeapFreeRatio=30 -XX:MinHeapFreeRatio=10 -Djava.awt.headless=true
Footprints 20.21.02	-Dfile.encoding=UTF-8 -XX:+UseG1GC -XX:MaxHeapFreeRatio=30 -XX:MinHeapFreeRatio=10 -Djava.awt.headless=true	--add-exports=java.naming/com.sun.jndi.ldap=ALL-UNNAMED
FootPrints 20.20.01 - 20.21.01	-Dfile.encoding=UTF-8 -XX:+UseG1GC -XX:MaxHeapFreeRatio=30 -XX:MinHeapFreeRatio=10 -Djava.awt.headless=true	--illegal-access=permit
FootPrints 12.1.x - 20.19.03	-Dfile.encoding=UTF-8 -XX:+UseParallelGC -Djava.awt.headless=true

In the Initial memory pool box, enter a value of 4096.
In the Maximum memory pool box, enter a value not more than 80% of your maximum server memory.

Click "Apply" to save your changes and close the dialog.
In General, tab, stop and start Tomcat service

4. Configure Server.xml file

Shutdown the Tomcat Service
Edit the server.xml file found under Tomcat's conf directory C:\Program Files\Apache Software Foundation\Tomcat x.x\conf\server.xml
Search for Connector port="8080" and highlighted attributes.

FootPrints Version	Attributes
FootPrints 20.19.X or later	<Connector port="8080" protocol="org.apache.coyote.http11.Http11NioProtocol" connectionTimeout="20000" redirectPort="8443" URIEncoding="UTF-8" maxThreads="550" maxHttpHeaderSize="65536" relaxedQueryChars="[]" />
FootPrints 12.1.x and 20.18.03	<Connector port="8080" protocol="org.apache.coyote.http11.Http11NioProtocol" connectionTimeout="20000" redirectPort="8443" URIEncoding="UTF-8" maxThreads="550" maxHttpHeaderSize="65536" />

Save the server.xml file
Re-start the server

For APR Module use these settings
Note: Please refer to the APR Protocol configuration article before proceeding further: How to install the Tomcat APR Module in Windows Server environments

FootPrints Version	Attributes
FootPrints 20.19.X or later	<Connector port="8080" protocol="org.apache.coyote.http11.Http11AprProtocol" connectionTimeout="3000" redirectPort="8443" URIEncoding="UTF-8" maxThreads="550" maxHttpHeaderSize="65536" relaxedQueryChars="[]" />
FootPrints 12.1.x and 20.18.03	<Connector port="8080" protocol="org.apache.coyote.http11.Http11AprProtocol" connectionTimeout="3000" redirectPort="8443" URIEncoding="UTF-8" maxThreads="550" maxHttpHeaderSize="65536" />

Sometimes you may notice that there is high HTTP traffic, and you may determine that it's because the server is attempting to return high volumes of data to the browser. In this case, if you are running Tomcat, you have the added option of turning on compression at the application server level. To enable compression adding the following attribute in the server.xml file in the Connector port="8080"

compression="on" compressionMinSize="2048"
noCompressionUserAgents="gozilla, traviata"
compressibleMimeType="text/html,text/xml,text/plain,text/css,text/javascript,application/x-javascript,
application/javascript,application/xml,application/extjson,x-font/otf,application/x-font-woff,x-font/ttf,x-font/eot"

Note:

If you are using secure LDAP (LDAPS) for authentication or Address Book. add this variable in Java Option -Dcom.sun.jndi.LDAP.object.disableEndpointIdentification=true
If Web Server Authentication is enabled (Single Sign-on), replace the following line in the server.xml file

<!-- Define an AJP 1.3 Connector on port 8009 -->
    <Connector port="8009" protocol="AJP/1.3" redirectPort="8443"/>

with:

<!-- Define an AJP 1.3 Connector on port 8009 -->
    <Connector port="8009" protocol="AJP/1.3" packetSize="65536" tomcatAuthentication="false" URIEncoding="UTF-8"/>