Requirements

Tomcat 8.5.5 and 8.5.6 were tested, and are the recommended versions to run. There are known issues with Tomcat 7.
4GB of RAM
1 CPU
JDK - refer to http://tomcat.apache.org/whichversion.html for selecting. Tomcat 8.5.5 was tested with JDK 1.7_67, 1.8_60 and 1.8_101.

Tomcat Setup

If FlexDeploy is being installed for first time, setup Tomcat server and a Data Source as explained in following steps. If only updating new war file, skip to WAR Installation.

Install Tomcat

Download the version of Tomcat Core built for your environment from this link: http://tomcat.apache.org/download-80.cgi#8.5.6

Install a supported version of the JDK following the install procedures provided with the JDK
Set the JAVA_HOME variable to the location the JDK was installed to
Extract Tomcat to a folder where it will reside and run from.

Install jars into tomcat lib

Some jars are needed to support running an ADF application on Tomcat. Please download the following and put in the lib folder inside where you downloaded Tomcat.

Download 12.1.3 Oracle ADF Essentials and Oracle ADF Essentials Client Files from http://www.oracle.com/technetwork/developer-tools/adf/downloads/adf-download-1649592.html. Save download files in temporary folder.

- Extract zip files in flat structure using unzip -j (works on Windows and UNIX)
  - cd <tomcat lib folder>
  - unzip -j <path to temp folder>/adf-essentials.zip
  - unzip -j <path to temp folder>/adf-essentials-client-ear.zip
- You should see a large number of jars now in the tomcat/lib folder.
Download the following jars and place them in tomcat/lib as well please.
- jta-1.1.jar
- jackson-core-lgpl-1.9.13
- jersey-bundle-1.18.jar
- asm-3.3.1.jar
- mail-1.4.7.jar
- Oracle JDBC driver matching your version of Java and database. You can download the drivers from the Oracle Technology Network site.
  - Oracle 11g drivers
  - Oracle 12c drivers
FDLogFormatter.jar is found in the zip file with the FlexDeploy war. Please copy that file into the tomcat/lib folder as well.

Configure context.xml

Open context.xml for editing. It is located in the conf folder where you extracted Tomcat.
Add the following text inside of the <Context> </Context> tags. change <password for fd_admin> to the actual password, and if necessary, changing your jdbc url as well.

Data Source

<!-- Prevent unnecessary warnings in the log.                                   -->
<JarScanner scanManifest="false"/>


<!-- Database Connection for the FlexDeploy Application                                   -->
<Resource name="jdbc/flexdbDS" auth="Container" type="oracle.jdbc.pool.OracleDataSource" factory="oracle.jdbc.pool.OracleDataSourceFactory"              
url="jdbc:oracle:thin:@localhost:1521:xe" user="fd_admin" password="put password for fd_admin" maxActive="100" maxIdle="10" maxWait="60" validationQuery="select 1 from dual" testOnBorrow="true"/>

Configure Tomcat Environment

WINDOWS

Create file setenv.bat in the tomcat \ bin folder
edit the file.

setenv.bat

set CATALINA_OPTS=%CATALINA_OPTS% -verbose:gc -Xms1024m -Xmx2048m -Doracle.mds.cache=simple -Dorg.apache.el.parser.SKIP_IDENTIFIER_CHECK=true -Dflexagon.fd.repository.root=/opt/flexdeploy/repository -Dflexagon.fd.install.root=/opt/flexdeploy/application -Djava.awt.headless=true

UNIX

Create file setenv.sh in the tomcat / bin folder.
edit the file.

setenv.sh

JAVA_HOME=/usr/jdk1.8.0_60
CATALINA_OPTS='-verbose:gc -Xms1024m -Xmx2048m -Doracle.mds.cache=simple -Dorg.apache.el.parser.SKIP_IDENTIFIER_CHECK=true -Dflexagon.fd.repository.root=/opt/flexdeploy/repository -Dflexagon.fd.install.root=/opt/flexdeploy/application -Djava.awt.headless=true'

Please make sure to modify the arguments for Server working directory (-Dflexagon.fd.install.root) and Artifacts repository (-Dflexagon.fd.repository.root) as per your installation. Be careful in copying arguments due to potential character changes.

Setup Logger Configuration

If you are working with a new Tomcat instance that is only running FlexDeploy, you can simply download the logging.properties file and place it in the tomcat/conf folder.

If you are running multiple applications on Tomcat, you will want to edit the logging.properties file as suggested below.

Edit logging.properties in the Tomcat/conf folder.
Add a new handler to the handlers line (starts with handlers=) by adding an additional handler to the end of the list.

, 5fd.org.apache.juli.AsyncFileHandler

Add the following lines to the file:

.handlers = 5fd.org.apache.juli.AsyncFileHandler


5fd.org.apache.juli.AsyncFileHandler.level = ALL
5fd.org.apache.juli.AsyncFileHandler.directory = ${catalina.base}/logs
5fd.org.apache.juli.AsyncFileHandler.prefix = flexdeploy.
5fd.org.apache.juli.AsyncFileHandler.formatter = flexagon.fd.logging.FlexDeployLogFormatter

org.apache.catalina.core.ContainerBase.[Catalina].[localhost].[/flexdeploy].level = INFO
org.apache.catalina.core.ContainerBase.[Catalina].[localhost].[/flexdeploy].handlers = 5fd.org.apache.juli.AsyncFileHandler


.level=INFO
flexagon.level=INFO
org.apache.jasper.servlet.level = WARNING
oracle.adf.share.security.level=SEVERE
oracle.adf.share.jndi.ReferenceStoreHelper.level=SEVERE

WAR Installation

Put the flexdeploy.war file into the webapps folder.
Start Tomcat.
- Unix
  - cd <tomcat install>/bin
  - ./startup.sh
- Windows
  - Double click startup.bat in the <tomcat install>\bin folder.