Versions Compared

Key

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

Preamble

We would like to welcome you as a customer of the Tax Transfer Hub.

In the following we provide instructions for the initial installation of the Tax Transfer 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 Transfer Hub in your company.

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 Transfer Hub installation.

Insert excerpt
TDH:Initial installation
TDH:Initial installation
nameDB_install
nopaneltrue

Insert excerpt
TDH:Initial installation
TDH:Initial installation
nameTomcat_install
nopaneltrue

Insert excerpt
TDH:Initial installation
TDH:Initial installation
nameTomcat_Config
nopaneltrue

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

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

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

When using a Microsoft SQL Server database driver with version greater than 10.x.x without encryption, the parameter “url” of the tag “resource” must be extended by “;encrypt=false (in this example url="jdbc:sqlserver://localhost:1433;databaseName=tth;encrypt=false")”

Insert excerpt
TDH:Initial installation
TDH:Initial installation
namewindows_auth_db
nopaneltrue

Code Block
languagexml
<Resource name="jdbc/TTHDataSource" type="javax.sql.DataSource"
                        maxTotal="100" maxIdle="30" maxWaitMillis="10000
						driverClassName="com.microsoft.sqlserver.jdbc.SQLServerDriver"
						url="jdbc:sqlserver://[SERVER-NAME];DatabaseName=[DATABASE_NAME];Integratedsecurity=true"/>

Connection to the module Portal

The registration of the module on the portal is carried out directly with Tomcat java option parameters. The following parameters are necessary in any case:

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

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

Optional to specify a different API address:

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

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

-Dtaxtransferhub.clientId=<Character String from the portal - ClientId>

-Dtaxtransferhub.clientSecret=<Character String from the portal - ClientSecret>

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 Transfer Hub module on the "Tomcat 9" application server.

Copy and unpack the war file from the delivery package into the "D:\Server\Tomcat\webapps" directory in the Tomcat installation directory. You can, of course, first edit the package to another location to do the configuration there and copy it to "\webapps" when finished.

Configure Transfer module

In the next step, you have to maintain the connection parameters to the desired transfer module (e.g. Tax Transfer DE).

  1. To do this, edit the corresponding ".properties" file in the "\WEB-INF\classes" directory of the war file.

  2. For communication with the German Elster interface, the value "tth.columba01.destination= must be set in the configuration file "application-columba-01.properties".

We recommend only storing communications via https for productive systems, as otherwise there will be no data security. Remember that for successful trust between the transfer module and the Tax Transfer Hub module, the corresponding certificate must be imported from the Central Authority in the Java directory. For other options for certificate maintenance, please read the section "Advanced configurations".

Insert excerpt
TDH:Initial installation
TDH:Initial installation
nameself-signed_Certificates
nopaneltrue

-Dtaxtransferhub.api.allowSelfSignedCertificat=true

Insert excerpt
TDH:Initial installation
TDH:Initial installation
nameTomcat_start
nopaneltrue

Insert excerpt
TDH:Initial installation
TDH:Initial installation
nameremarks
nopaneltrue

  1. It is recommended to exchange the API key regularly. To do this, a new API key is transferred via a Java option parameter and made known to the business modules.