Prerequisites (2021 Release 02)


This topic describes the steps that you must perform before you start upgrading to or installing FootPrints 2021 Release 02, depending on your OS installation.

Required application deployments

Before installing or upgrading FootPrints, deploy the following applications on your FootPrints Server environment:

  • Apache Tomcat 8.5 or Apache Tomcat Version 9.x
  • Java OpenJDK 17 (earlier versions of Java OpenJDK are not supported)

Reconfigure default ports

If you are upgrading from releases earlier than FootPrints 2018 Release 03, you must reconfigure the following default ports of Tomcat 7 in the server.xml file to other port numbers:

  • Port 8080
  • Port 8005
  • Port 8009

Tomcat 8 uses these port numbers for FootPrints 2021 Release 01.

Update new time zone data

With changes in Daylight Saving Time and time zone settings, you must update new time zone data in all FootPrints environments to access the User Management settings. Updating new time zone data is important to make sure that FootPrints continues to calculate correct date and time for all time zones.

To set up new time zone data for your environment, perform the steps in the Knowledge Article 000377542

For Microsoft Windows installations

Click here to expand...

If you have Windows installed, perform the following steps:

  1. Install OpenJDK 17.

    Important

    • FootPrints does not support earlier versions of OpenJDK.
    • The default Java installations that are a part of the operating system might not include all the functionality required to run FootPrints. You must download and install Java even if it is already a part of the operating system.
  2. Extract and copy the jdk folder into the Program files folder. For example, C:\Program Files\Java.
  3. Install and configure Tomcat 8.5 or Apache Tomcat Version 9.x:
    1. Download Tomcat 8.5 or Apache Tomcat Version 9.x from the Apache Tomcat website.
    2. Go to the Tomcat installation folder. For example, C:\Program Files\Apache Software Foundation\Tomcat 8.5\bin.
    3. Start the Tomcat Service Wrapper (Tomcat8w.exe or Tomcat9w.exe).
    4. From C:\Program Files\Java\jdk-<version>\bin\server\jvm.dll, select JVM.
      Refer to the following figure when you are updating the Tomcat Service Wrapper:
      TomcatScreenShot.PNG
    5. Open a command window with admin rights and run the following commands to set the JAVA_HOME and PATH environment variables to point to the correct Java version:

      setx -m JAVA_HOME "C:\Progra~1\Java\jdk-<version>"
      setx -m PATH "%PATH%;%JAVA_HOME%\bin";

      Important

      • Use the appropriate version in the command in accordance with your jdk version.
      • The setx -m PATH command does not work correctly if the PATH has more than 1,024 characters.
      • (2021 Release 02 only) In the Java 9 Options section, add --add-exports=java.naming/com.sun.jndi.ldap=ALL-UNNAMED

For Red Hat Linux installations

Click here to expand...

If you have Linux installed, perform the following steps:

  1. Install OpenJDK 17.

    Important

    • FootPrints does not support earlier versions of OpenJDK.
    • The default Java installations that are a part of the operating system might not include all the functionality required to run FootPrints. You must download and install Java even if it was already a part of the operating system.
  2. Extract and copy the jdk folder. Set the JAVA_HOME environment variable in Linux, where the JAVA plus HOME value is the path extracted in the previous step.

    Example
    JAVA_HOME="/opt/java/jdk-<version>"
    export JAVA_HOME                   
    export PATH=$PATH:$JAVA_HOME/bin    

    Important

    Use the appropriate version in the command in accordance with your jdk version.

  3. In the terminal, enter the command echo $JAVA_HOME to check whether the environment variable is set correctly. The command must return the OpenJDK 17 path.

    Important

    If the command does not return the correct OpenJDK path, restart the machine.

  4. Install and configure Tomcat 8.5 or Tomcat 9.x:
    1. Download Tomcat 8.5 or Tomcat 9.x from the Apache Tomcat website.
    2. Go to the Tomcat 8.5 or Tomcat 9.x bin directory (/tomcat8.5/bin).
    3. Create a setenv.sh file or open the file if it already exists.
    4. Add the following lines in the file:

      export JAVA_HOME=/opt/java/jdk-<version>
      export CATALINA_OPTS="$CATALINA_OPTS -Xms2048m"
      export CATALINA_OPTS="$CATALINA_OPTS -Xmx8192m"
      export CATALINA_OPTS="$CATALINA_OPTS -XX:MaxPermSize=256m"
      export JAVA_OPTS="$JAVA_OPTS -Dfile.encoding=UTF-8"

      Important

      Use the appropriate version in the command in accordance with your OpenJDK version.

  5. If FootPrints is not started via Tomcat 8.5 or Tomcat 9.x and Tomcat logs contain an error related to cxf, add the following line in the setenv.sh file:

    export CATALINA_OPTS="$CATALINA_OPTS -Dorg.apache.cxf.stax.allowInsecureParser=1"

Where to go from here

See Installing or Upgrading.

 

Tip: For faster searching, add an asterisk to the end of your partial query. Example: cert*