Versions Compared

Old Version 10

changes.mady.by.user ANI

Saved on

compared with

New Version Current

changes.mady.by.user ANI

Saved on

Key

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

...

In the following we provide instructions for the initial installation of the Tax Data Hub on a Tomcat application server. If your requirements for the installation differ from the assumptions made here, we will be happy to advise you to facilitate the integration of the Tax Data Hub in your company.

Tax Data Hub 24.1.1 and newer

If you want to install version 24.1.1 (or newer) of Tax Data Hub, please install Tomcat 10.1.

In this case, please read the linked instructions.

Checking the preconditions - infrastructure

Please use the System requirements document to check whether your infrastructure is up to date. If this is not the case, please update the infrastructure before you start with the Tax Data Hub installation.

Excerpt
nameDB_install

Installation of database

The steps for setting up are kept general at this point in order to do justice to the different configurations of the database systems.

  1. Create a new database schema on the database server.

  2. Create a database user with permission to "INSERT", "UPDATE", "DELETE", "ALTER", "CREATE" on this database.

    1. In SQL Server, the user needs the database roles db_datareader, db_datawriter and a role for executing stored procedures, e.g.: db_executor:

      Code Block
      languagesql
      CREATE ROLE db_executor
GO
GRANT EXECUTE TO db_executor
GO

  3. Make sure that the application server can connect to the database with this user.

  4. Please ensure that a current JDBC driver package, suitable for your DBMS and the Java version used, is in the lib directory of the Tomcat.

  5. The database schema is automatically created and updated when the application is started.

  6. Make sure that the user who imports the DB scripts has all rights on the this database.

Excerpt
nameTomcat_install

Installation of the Web Application Server

As a rule, the module is set up on the same Tomcat on which the module Portal is installed. In this case, a Tomcat already exists. You can skip the steps "Installing the JDK" and " Installation of the Tomcat 9".

In the following, we assume an installation on a Windows operating system. An installation on a Unix-like system differs mainly in the paths.

Installation of the JDK

Install a suitable JDK 17 and create the system variable "JAVA_HOME", which points to the installation directory.

Installation of the "Tomcat 9"

Install Apache Tomcat 9 in a directory of your choice. We recommend installing Tomcat to a drive other than "C:", in the further process the directory "D:\Server\Tomcat" is assumed.

We recommend installing the entries for the start menu to simplify the configuration.

The ports used by the Tomcat can be adapted according to your requirements.

Excerpt
nameTomcat_Config

Configuration of the "Tomcat 9"

...

Memory

  1. After installation, run the application "->Startmenu->Tomcat->"configure tomcat" and perform the following steps:

    1. Tab "General": Set the start of the service to automatic.

    2. Tab "Java": Enter "512" in the field "Initial Memory Pool".

    3. Tab "Java": In the field "Maximum Memory Pool" enter approximately half of the available physical memory. For example, 2048 for 4096 MB RAM. For 32-bit systems, please bear in mind the limitation of the working memory to approx. 3.5 GB. The memory settings made here affect the performance and runability of the application. They may need to be adjusted over time as usage increases.

HTTPS

Make the necessary connector settings in the „D:\Server\Tomcat\lib\server.xml" configuration file to ensure communication via https. A reference to a valid key store for identifying the module to other applications must be maintained.

Connection to the database

Database driver

Copy the database driver that matches your database server into the "\lib" directory in the Tomcat installation directory.

  1. Microsoft SQL Server - https://docs.microsoft.com/en-us/sql/connect/jdbc/microsoft-jdbc-driver-for-sql-server

Configuration

Configure the database connection as a JNDI connection in Tomcat:

  1. Open the "context.xml" file in the "\conf" directory of the Tomcat.

  2. Add a new "Resource" XML tag with appropriate attributes for your DBMS and name "jdbc/taxdatahubdatasource".
    Example "Resource" XML tag for MSSQL

    Code Block
    languagexml
    <Resource name="jdbc/taxdatahubdatasource" auth="Container" type="javax.sql.DataSource"
               maxTotal="100" maxIdle="30" maxWaitMillis="10000"
               username="taxdatahub" password="taxdatahub" driverClassName="com.microsoft.sqlserver.jdbc.SQLServerDriver"
               url="jdbc:sqlserver://localhost:1433;databaseName=taxdatahub" />

...

Excerpt
namewindows_auth_db

Windows authentication

(Optional for Microsoft SQL Server)

From the JDBC driver package, the appropriate “*.dll”-file must also be copied from the folder “auth” into the directory “System32” of the system.
Example path: .\sqljdbc_8.2.2.0_deu\sqljdbc_8.2\deu\auth\x64\mssql-jdbc_auth-8.2.2.x64.dll

  1. The Windows user must be entered in Tomcat

    1. The user needs permissions on the server of the Tomcat to run the Tomcat service as well as write permissions in the Tomcat folder for logs.

    2. The user needs permissions on the database server.

    3. The user needs the above-mentioned permissions on the database schema.

      Image RemovedImage Added

  2. The connections in the context.xml must correspond to this example:

...

-Dtaxdatahub.url.base=<URL of the module Tax Transfer Data Hub>

-Dtaxdatahub.url.portal=<URL of the module Portal>

...

-Dtaxdatahub.url.api=<API URL of the module Tax Transfer Data Hu>

Optionally required for static registration (if the module and the portal are installed on one Tomcat):

...

Info

The URLs must always be specified with port, even if it is a standard port (e.g. 80 or 443).

Communication with other GTC Suite modules (API key)

For secure communication with other modules in the GTC Suite, an API key has to be generated. You can access the documentation via this link.

Deployment setup

The following steps set up the Tax Data Hub module on the "Tomcat 9" application server.

...

Excerpt
nameself-signed_Certificates

Use of Self-Signed Certificates

If you have integrated a self-signed TLS/SSL certificate in Tomcat, it can happen that HTTP requests from the Tax Data Hub this module to other modules cannot be carried out. In this case, enter the following parameter in the "Java Options" field in Tomcat. This explicitly allows the use of self-signed certificates in the application. This configuration is generally not recommended for productive systems.

-Dtaxdatahub.api.allowSelfSignedCertificat=true

Excerpt
nameTomcat_start

Start

  1. Start the Tomcat application server on which you have installed the

...

  1. service module, either under System Services or with the "Configure Tomcat" application.

  2. Wait until the server has started.

...

Open a supported browser and enter the following in the address bar (note the port selected when installing the Tomcat): "http://:/taxdatahub".

...

  1. Whether the service module has been configured correctly and is accessible from other modules can be checked via the module view of the portal. To do this, log in to the portal with administration rights and click on Modules in the Administration tab.

  2. The service module appears in the list and is indicated by a green traffic light. If the traffic light is yellow, check the connection properties to see whether the corresponding paths have been maintained correctly and check whether the https connection has been maintained correctly.

Excerpt
nameremarks

Concluding remarks

The software can now be handed over to the departments for use or professional testing.

Finally, a few comments:

  • We would like to recommend that you make a regular backup of the database, as this contains the data of the application.

  • The deployment does not have to be backed up constantly. Here it is sufficient to have the status ready when a version is delivered.