Versions Compared

Key

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

FlexDeploy provides a zip 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. 

  • A tomcat 8.5.11 server with required libraries, and base configurations
  • The FlexDeploy WAR
  • The FlexDeploy database installation scripts
  • The FlexDeploy plugins

Requirements 

...

  • .
Info

This distribution requires an Internet connection the first time that you run it. About 200 MB will be downloaded the first time.

This method of launching FlexDeploy will also download and install PostgreSQL and setup the database connection to it. If that isn't what you want to do, look at a different install guide instead.

4 steps to running FlexDeploy with embedded database

Step 1. Ensure Java 8 64 bit is installed on the servercomputer.

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

Tip

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

Image RemovedImage Added

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

...

Start tomcat by running the following script. (Double click on it, or run it from a command window)

File - <FlexDeploy Home>/apache-tomcat-flexdeploy/conf/context.xml

Tip
titleExample JDBC URL (CONNECT_STRING)
  • Oracle
    • Localhost XE connection will look like this. jdbc:oracle:thin:@localhost:1521:XE
    • SID based JDBC URL Syntax - jdbc:oracle:thin:@HOSTNAME:PORT:SID
    • Service Name based JDBC URL Syntax - jdbc:oracle:thin:@//HOSTNAME:PORT/SERVICENAME
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=60, AbandonedConnectionTimeout=60, PropertyCheckInterval=30}"
    
    validationQuery="select 1 from dual"
    testOnBorrow="true"
    
    useLocalSessionState="true"
    defaultAutoCommit="false"/>
Code Block
languagexml
themeRDark
titlePostgresql
<Resource name="jdbc/flexdbDS" auth="Container"
    type="javax.sql.DataSource"
    factory="org.apache.tomcat.jdbc.pool.DataSourceFactory"
    driverClassName="org.postgresql.Driver"
    
    url="**CONNECT_STRING**"
    username="fd_admin"
    password="**FD_ADMIN_PASSWORD**"
    
    maxTotal="100"
    maxIdle="20"
    
    validationQuery="select 1"
    testOnBorrow="true"
    
    defaultTransactionIsolation="READ_COMMITTED"
    useLocalSessionState="true"
    defaultAutoCommit="false"/>
Code Block
languagexml
themeRDark
titleMySQL
<Resource name="jdbc/flexdbDS" auth="Container"
    type="javax.sql.DataSource"
    factory="org.apache.tomcat.jdbc.pool.DataSourceFactory"
    driverClassName="com.mysql.jdbc.Driver"
    
    url="**CONNECT_STRING**"
    username="fd_admin"
    password="**FD_ADMIN_PASSWORD**"
    
    maxTotal="100"
    maxIdle="10"
    initialSize="10"
    
    validationQuery="SELECT 1"
    testOnBorrow="true"
    
    defaultTransactionIsolation="READ_COMMITTED"
    useLocalSessionState="true"
    defaultAutoCommit="false"/>

Step 5. (Optional) Modify Tomcat server.xml for port if necessary. 

File - <FlexDeploy Home>/apache-tomcat-flexdeploy/conf/server.xmlStartWithPostgres.bat

When you run this for first time, it will download & install PostgreSQL database, then create FlexDeploy schema in it. Here are some screen shots to show progress of first execution of StartWithPostgres.bat.

Image Added

Image Added

Image Added

You will also see Tomcat process window when Tomcat is started.

Image Added

Step 4. FlexDeploy will automatically launch in your default browser (http://localhost:8000/flexdeploy). (It will take about 3-5 minutes the first start due to initial data load)

You will need to complete the Initial Registration process, where you will create admin user for login.

If FlexDeploy doesn't appear after a few minutes, here are some troubleshooting tips:

  • Logs are located at <FlexDeploy Home>/apache-tomcat-flexdeploy/logs
  • Usually opening flexdeploy.0.log is the best way to find the problem. The most common problem is that a port that Tomcat wants to use is already in use.
  • By default, the Tomcat server is configured to run on port 8000. If this port is in use, change to some other unused port. Search for <Connector port="8000" protocol="
  • HTTP
  • dHTTP/1.1"
  •  if
  • , if you want to change it...
    • Edit the file at <FlexDeploy Home>/apache-tomcat-flexdeploy/conf/server.xml
    • There are other ports referenced in the server.xml file as well. If the logs contain a port in use error, you can find the open ports on your machine and then search this file for ports that you find are in use and change them
  • .

...

    • .
Tip

If you are setting up FlexDeploy for Trial purposes, it is good idea to leave directories as default,  but

if you are setting up FlexDeploy for production use, then we recommend to modify to use directory structure outside of FlexDeploy installation.

File - <FlexDeploy Home>/apache-tomcat-flexdeploy/bin/setenv.sh (setenv.bat on windows)

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 Removed

Default setenv.bat is shown below.

Image Removed

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

Image Removed

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

File - <FlexDeploy Home>/apache-tomcat-flexdeploy/bin/setenv.sh (setenv.bat on windows)

Tip

Even when JAVA_HOME is already set in your environment, it would be a good idea to set it in this file (setenv.sh or setenv.bat) as well.

Unix Example - export JAVA_HOME=/u01/java/jdk1.8.0_121

Windows Example - set JAVA_HOME=c:/installs/Java/jdk1.8.0_121

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

Image Removed

Step 8. 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.

Note

If adding another JDBC driver, be sure to remove the default one which comes with the ADF Essentials libraries (ojdbc6dms.jar).  If you leave multiple 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) If using IBM ClearCase, you will need to copy some jar files from your ClearCase server or ClearTeam Explorer installation to the FlexDeploy installation

Copy all of the jar files found in the com.ibm.rational.teamapi_8.0.1.vxxx folder of your ClearCase server or ClearTeam Explorer installation to <FlexDeploy Home>/apache-tomcat-flexdeploy/lib. (commons-codec-1.3.jar, commons-lang-2.3.jar, icu4j-4_8.jar, remote_core.jar, stpclientws.jar, stpcq.jar, teamapiextensions.jar, unicodetypemgr.jar, commons-httpclient-3.0.jar, commons-logging-1.0.4.jar, icu4j-charset-4_8.jar, stpcc.jar, stpcmmn.jar, stpwvcm.jar, ucleardiffmerge.jar)

Step 10. Linux only - set the shell scripts executable with this command:chmod +x <FlexDeploy Home>/apache-tomcat-flexdeploy/bin/*.sh

Step 11. Skip this step if you did not modify setenv.sh or setenv.bat to use non-default server side directories in Step 6.

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. 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.

...

  • If the logs folder doesn't have any useful information, and you aren't sure what else to try, use a command window and go to the bin folder. Then execute the command "catalina.bat run" A better error message should be shown.
  • If you still aren't sure what to do, email us at our support site, support@flexagon.com
  • If you get any Java related errors, verify that you have Java 7 or 8 64 bit installed. If troubles persist, modify theTomcat Environment script setenv.bat for JAVA_HOME.

    • <FlexDeploy Home>/apache-tomcat-flexdeploy/bin/

...

Image Removed

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 13. Launch FlexDeploy in your browser.

  • http://hostname:8000/flexdeploy
    • Update hostname in URL to indicate host where FlexDeploy is installed.
    • Update port if you had modified server.xml for different port number.
  • You will need to complete Initial Registration process, where you will create admin user for login.

...

    • setenv.bat