The content of this chapter is intended for system administrators. Here, you can learn how to install and configure Web Application Platform and its services without using the installer file.

Web Application Platform with its services can run on the following third-party web servers like:

  • Apache Tomcat
  • GlassFish
  • WildFly
  • Eclipse Jetty

Installation prerequisites and other important information

Before installing Web Application Platform with services, you need to:

  • Have a working instance of Teamwork Cloud.
  • If you intend to install the Cameo Collaborator for Teamwork Cloud service, make sure that the FlexNet license server is installed beforehand.
  • 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.
  • Have access to the KeyStore file with the same certificate that is used in Teamwork Cloud for authentication configuration.
  • Download the Web_App_Platform_<version number>_<operating system>_no_install.zip file which includes the following web applications:
    • admin.war - The service for managing Teamwork Cloud users, roles, and resource assignments.
    • authentication.war - The service allowing users to authenticate access to Teamwork Cloud.
    • collaborator.war - The service allowing users to review, edit, and collaborate on Cameo Collaborator documents.
    • document-exporter.war - The service allowing users to export Cameo Collaborator documents to PDF and HTML.
    • oslc.war - The service allowing users to browse the model through OSLC.
    • reports.war - The service allowing users to export Teamwork Cloud server-related data to XLSX or CSV.
    • resources.war - The service for managing Teamwork Cloud resources.
    • resource-usage-map.war - The service with live visual graph capabilities representing Teamwork Cloud resource usages and identifying potential problem areas.
    • simulation.war - The service allowing users to simulate Teamwork Cloud projects on the server side.
    • webapp.war - The core Web Application Platform service.

Before starting the installation, you should know the following:

  • We recommend installing Web Application Platform and Teamwork Cloud on different machines.
  • Before installing Web Application Platform, make sure to note down Zookeeper, Cassandra, Teamwork Cloud, and the FlexNet server information (e.g., hostname and port), as well as the KeyStore file location (you can find it in the <install_root>/TeamworkCloud/configuration directory). You will need this data during installation.
  • After installing Web Application Platform, it is recommended to stop the WebApp service on the machine where Teamwork Cloud is installed.


To install Web Application Platform

  1. Download and install the web server on which 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. Open for editing the <no-install_root>/CATIANoMagicServices/WebAppPlatform/shared/conf/webappplatform.properties file, read the comments with property descriptions, and specify the following:
    • Web Application Platform properties
    • Authentication server properties
    • Teamwork Cloud server properties
    • FlexNet/DSLS server properties
    • Platform service discovery-related properties
  4. If you want to install the Authentication server (authentication.war) together with Web Application Platform, open for editing the <no-install_root>/CATIANoMagicServices/WebAppPlatform/shared/conf/authserver.properties file, read the comments with property descriptions, and specify the following:
  5. Place the following files into the location that is on the classpath of the web server you have installed:
    • <no-install_root>/CATIANoMagicServices/WebAppPlatform/shared/conf/webappplatform.properties file
    • <no-install_root>/CATIANoMagicServices/WebAppPlatform/shared/conf/authserver.properties file (if you want to install the Authentication server (authentication.war))

    • <no-install_root>/CATIANoMagicServices/WebAppPlatform/shared/conf/data directory containing email notifications and document exporter templates (if you plan to install Cameo Collaborator for Teamwork Cloud (collaborator.war) and/or document exporter (document-exporter.war))

      Example

      If you have installed Apache Tomcat 10.1 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.

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

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

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

Starting Web Application Platform manually

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