Versions Compared

Key

  • This line was added.
  • This line was removed.
  • Formatting was changed.

FlexDeploy provides a file distribution for Tomcat which simplifies the installation process.  This distribution contains Tomcat, the FlexDeploy WAR, and the base configurations, leaving only a few simple steps to complete the install. The distribution contains the following components. 

...

Installation Instructions

Adjust for Windows path if you are installing on Windows platform.

Step 1. Ensure Java 8 is installed on the server.

In this example, JAVA_HOME is /u01/java/jdk1.8.0_171 but it can be anything you want. If default java is not version 8, then we will need to adjust for it during Step 7 later. 

Image Added

Step 2. Extract the zip file in the desired location (referred to as "FlexDeploy Home" in this document). See example below, where zip was extracted in C:/installs/FlexDeploy folder.Image Removedu01/flexdeploy folder.

Tip

We recommend use of folder structure without any space in name.

Image Added

Here is how it will look like after unzip.

Image Added

Step 3. Setup the database for FlexDeploy, if you not already done so.

...

Tip
titleExample JDBC URL (CONNECT_STRING)


Code Block
languagexml
themeRDark
titleOracle
<Resource name="jdbc/flexdbDS" auth="Container"
    type="oracle.jdbc.pool.OracleDataSource"
    factory="oracle.jdbc.pool.OracleDataSourceFactory"
    
    url="**CONNECT_STRING**"
    user="fd_admin"
    password="**FD_ADMIN_PASSWORD**"
    
    connectionCachingEnabled="true"
    connectionCacheProperties="{InitialLimit=0, MinLimit=0, MaxLimit=100, ConnectionWaitTimeout=60, InactivityTimeout=60300, AbandonedConnectionTimeout=60300, PropertyCheckInterval=30}"
    
    validationQuery="select 1 from dual"
    testOnBorrow="true"
    
    useLocalSessionState="true"
    defaultAutoCommit="false"/>

...

Below are default artifact and working directories created under FlexDeploy Home when you extracted zip file. If you want to use different directories then modify setenv.sh or setenv.bat file, otherwise skip this step.

Image RemovedImage Added

Default setenv.bat sh is shown below.

Image RemovedImage Added

Here is example of setenv.bat sh which is modified to use non-default folders.

Image RemovedImage Added

Step 7. (Optional) Modify Tomcat Environment script (setenv.sh or setenv.bat) for JAVA_HOME.

...

 If you were also setting JAVA_HOME, this file would look like this.

Image RemovedImage Added

Step 8. (Only if using Oracle Database) ADF Essentials comes with the JDBC driver for Oracle 11g database (ojdbc6dms.jar). If you are using Oracle 12c database, you can download the driver (ojdbc7.jar) from the Oracle Technology Network site at Oracle 12c drivers. Delete ojdbc6dms.jar from <FlexDeploy Home>/apache-tomcat-flexdeploy/lib and place ojdbc7.jar in that same folder.

...

Info
titleIf using different Oracle driver

If you use different Oracle JDBC driver (ojdbc7.jar, ojdbc8.jar etc.), then remove ojdbc6dms.jar. If you leave multiple Oracle JDBC drivers in the lib folder, you could encounter the following exception on startup:

java.lang.SecurityException: sealing violation: package oracle.jdbc is sealed
                     at java.net.URLClassLoader.getAndVerifyPackage(Unknown Source)
                     at java.net.URLClassLoader.definePackageInternal(Unknown Source)
                     at java.net.URLClassLoader.defineClass(Unknown Source)
                     at java.net.URLClassLoader.access$100(Unknown Source)
                     at java.net.URLClassLoader$1.run(Unknown Source)

Step 9. (Optional) Only ff if using IBM ClearCase, you will need to copy some jar files from your ClearCase server or ClearTeam Explorer installation to the FlexDeploy installation

...

If you are using non-default server side directories, then move all the jar files from <FlexDeploy Home>/application/plugins to FLEXDEPLOY_WORKING_DIR/plugins. At startup, FlexDeploy will load all the plugins.

Step 12. (Optional) Only if running FlexDeploy on a mysql a MySQL database.

  • Due to licensing restrictions, the mysql jdbc driver is not included in the FlexDeploy zip file. Please download it from
  • https://dev.mysql.com/downloads/connector/j/
  • Download a version 8.0 jar.
  • Place it in <FlexDeploy Home>/apache-tomcat-flexdeploy/lib folder.

Step 13. Start tomcat by running the following script. Make sure to set JAVA_HOME to JDK 7 or JDK 8 if not already set in your environment.

File - <FlexDeploy Home>/StartFlexDeploy.sh(you can also use startup.sh or startup.bat scripts)

Image RemovedImage Added

Note
titleNote for Oracle XE Database

After starting your server, check the <FlexDeploy Home>/apache-tomcat-flexdeploy/logs/flexdeploy.0.log file for the following error message:

  • ORA-12519, TNS:no appropriate service handler found

If present, increase the number of processes for the database

  • Using SQLPlus update processes setting.
    • alter system set processes=200 scope=spfile;
  • Stop Tomcat
  • Restart the XE Database
  • Start Tomcat

...

Step 15. Go to Administration - Plugins on FlexDeploy. Verify that Plugins are loaded. You should not see any files remaining in FLEXDEPLOY_WORKING_DIR/plugins folder after few minutes.

Step 16. Now that you have installed FlexDeploy, let's get start with configuration. You can do this in matter of minutes by using Blueprints concept, which is very simple configuration wizard for most common usecases.