Here you can learn how to install and configure Web Application Platform with its services, such as Cameo Collaborator, Resources, etc.

Web Application Platform with its services can run on the following third-party web containers that work with Java 17:

  • Apache Tomcat
  • GlassFish
  • WildFly
  • Eclipse Jetty

Installation prerequisites

  • You must have a working instance of Teamwork Cloud.
  • If you intend to install the Cameo Collaborator for Teamwork Cloud application, make sure that the FlexNet license server is installed beforehand.
  • Before installing Web Application Platform, make sure you know Teamwork Cloud, Authentication server and FLEXnet server data, such as the hostname (or IP address) and port. You will need to enter this data during installation.
  • You have to download the Web_App_Platform_<version number>_<operating system>_no_install.zip file, which includes the following web applications:
    • admin.war
    • authentication.war
    • collaborator.war
    • document-exporter.war
    • oslc-selection-dialog.war
    • reports.war
    • resources.war
    • resource-usage-map.war
    • simulation.war
    • webapp.war
  • For deployment on Linux, increase the open file limit for the OS (or for Web Application Platform/Tomcat) to a minimum of 20 000 files.
  • For production use, Web Application Platform and Teamwork Cloud should be installed on different machines.
  • After installing Web Application Platform, it is recommended to disable the web container (e.g., Apache Tomcat) on the machine where Teamwork Cloud is installed.


To install the Web Application Platform

  1. Download and install a Java application server or servlet container on which the Web Application Platform will run. For installation instructions, see the documentation of the server you intend to install.
  2. Download and extract the Web_App_Platform_<version number>_<operating system>_no_install.zip file.
  3. Go to the <no-install_root>/shared/conf directory.

  4. Open to edit the webappplatform.properties file, read the comments with property descriptions, and specify the following:

    • Web Application Platform properties
    • Teamwork Cloud server properties
    • Authentication server properties
    • FlexNet server properties
    • Platform service discovery-related properties
  5. If you want to install the Authentication server (authentication.war) together with Web Application Platform, do the following:
    1. Go to the <no-install_root>/shared/conf directory.
    2. Open to edit the authserver.properties file, read the comments with property descriptions, and specify the following properties:

  6. Place the webappplatform.properties file (and the authserver.properties file if you intend to install the Authentication server) into the location that is on the classpath of the web application container you have installed.

    Example

    If you have installed Apache Tomcat 9.0 or a later version, you can choose from the following options (refer to server documentation for all available options):

    • Place the webappplatform.properties file in the <tomcat_home>/shared/conf directory. Then open the <tomcat_home>/conf/catalina.properties file and set the shared.loader property as shared.loader="<catalina_base>/shared/conf".
    • Place the webappplatform.properties file in a custom directory. Add the path to the directory to the list of shared classloader paths defined by the "shared.loader" property in the ${tomcat.home}/conf/catalina.properties file. 

    If you have installed a different web application server, refer to its user manual.

  7. Deploy the desired web applications, e.g., webapp.war, admin.war, collaborator.war, resources.war, etc.

  8. Open a web browser and navigate to http(s)://<host>:<container_port>/<platform_root>/. You should see a blank page.

  9. When the installation is finished, update the authentication.redirect.uri.whitelist property in the authserver.properties file by adding the Web Application Platform address http(s)://<domain_name>:<port>/webapp as its value.
  10. If you chose to install Cameo Collaborator for Teamwork Cloud, apply the Cameo Collaborator license.


Once Web Application Platform with plugins is installed, access it by opening a web browser and navigating to http(s)://<domain_name>:<port>/webapp/resources. By default, the Web Application Platform uses the port 8443.

Starting Web Application Platform manually

 If you want to start Web Application Platform, start Zookeeper first and only then - Web Application Platform.


Related pages