Deployment as WAR / in Tomcat (tC)

Container deployment is recommended: Deployment using Container (tC)

WAR packages for deployment of tia® Core are stored at https://download.kgs-software.com/?login

An account is required. It is provided for licensed installations via kgs Customer Support https://kgs-software.atlassian.net/servicedesk/customer/portal/2/group/2/create/19

Prerequisites

Prerequisites for tia® and kgs Software Components

WAR packages can be deployed on any application web server that supports JAVA JDK 17 or higher and JarkartaEE Servlet version 5.0 or higher.

It is required, that the correct version of Java JDK and application web server is already set up before installing tia® Core application.

Installation of tia® Content Server core

Web Application Context Name

Choose a desired web application context name and rename the .war file accordingly.

Example:

The .war file is called tiaContentServer-saphttp-3.8.0.war. But the desired URL for accessing the Status UI is: https://1.2.3.4:8443/tiaCore-CS/info.

Then the application context name is: tiaCore-CS

To achieve this, the .war file must be renamed as follows: tiaCore-CS.war.

Configure the configuration location

The Tomcat context file is an XML file with the same name as the web application context name (respective the .war file deployed. E.g. tiaCore-CS.xml). For more information see Apache Tomcat documentation: https://tomcat.apache.org/tomcat-10.0-doc/config/context.html.

Best practice Example:

Shut down Apache Tomcat
Navigate to <tomcat installation>/conf/Catalina/localhost directory

Create a file called like the application context name with .xml extension e.g. tiaCore-CS.xml. The advantage of this procedure is that the web context and the configuration are not overwritten even if the .war file is updated, as long as the name of the .war file remains the same as before the update.

Example configuration of the context file e.g tiaCore-CS.xml:

<?xml version="1.0" encoding="UTF-8"?>
<!DOCTYPE Context>
<Context>
    <Parameter
        name="logging.level.com.software.kgs"
        value="info"
        override="true" />
	<Parameter
        name="logging.config"
        value="C:/Program Files/Apache Software Foundation/Tomcat 10.1/conf/logback-spring.xml"
        override="true" />
    <Parameter
        name="volumecounter.file.counterSender.targetUrl"
        value="https://vcrs.kgs-cloud.de"
        override="true" />
    <Parameter
        name="volumecounter.file.counterSender.isActive"
        value="true"
        override="true" />
    <Parameter
        name="volumecounter.file.counterSender.proxy.uri"
        value=<yourProxyURL>
        override="true" />
    <Parameter
        name="volumecounter.file.counterSender.proxy.user"
        value=<yourProxyUser>
        override="true" />
    <Parameter
        name="volumecounter.file.counterSender.proxy.password"
        value=<yourProxyPassword>
        override="true" />
    <Parameter
		name="configDirectory"
		value="C:/Program Files/Apache Software Foundation/Tomcat 10.1/conf/repository"
        override="true" />
	<Parameter
		name="configFile"
		value="repository.cfg"
        override="true" />
	<Parameter
        name="tia.license.path"
        value="C:/Program Files/Apache Software Foundation/Tomcat 10.1/conf/license"
        override="true" />
	<Parameter
		name="webapp.security.auth.type"
		value="basic"
        override="true" />
	<Parameter
		name="webapp.security.auth.basic.username"
		value="admin"
        override="true" />
	<Parameter
		name="webapp.security.auth.basic.password"
		value="$2a$10$eswhIo8VjEviekZxaq1FLukR7I59dEdHiLE.kGEINbfSjA1cZWjG2"
        override="true" />
</Context>

Navigate toC:/Program Files/Apache Software Foundation/Tomcat 10.1/conf
Create a new folder license and put the license into it

Take the logback-spring.xml and the repository.cfg and put it into the C:/Program Files/Apache Software Foundation/Tomcat 10.1/conf folder

During the deployment the .war file will be extracted and the default configuration is available at /WEB-INF/classes/config/repository.cfg . In the context.xml the location of repository.cfg can be changed - see example above.

The folder and file for repository.cfg as well as a key store configuration, if any, needs to be readable by tomcat process. Don't put these configuration inside a user folder of another user like your login user! otherwise the webapp within tomcat does not have the access permission and will not start.

restart the the Tomcat Service

WAR file deployment

Choose the tiaCore-CS.war file and deploy it into the webapps folder of the Apache Tomcat installation:

After this step the tomcat should deploy and create a folder in its webapps directory

Apache Tomcat Manager App

Open the Tomcat configuration page and Click on the Manager App button.

Apache Tomcat Manager App

Choose the deployed .war file from tomcat manager e. g. /tiaCore-CS.

The successfully installed tiaCore-CS now presents the UI of tia core: