• Ready for review

    • Host Tax Transfer DE in a Windows Service

    Owned by Sebastian Wellsandt
    Last updated: Aug 17, 2023
    1 min read

    Hosting Tax Transfer DE in a Windows Service is available from Tax Transfer DE 2.4.176+eric.37-4-10.

    1. Obtain the installation resources of Tax Transfer DE from the download link that was provided to you via E-mail.

    2. Extract the archive to a desired location on the file system of the machine that will host Tax Transfer DE. We will refer to that location as <tax-transfer-de-install-directory>.

    3. Use PowerShell (Version 6 or later) to register a service. From an administrative PowerShell command shell execute the following command:

      New-Service -Name "Tax Transfer DE" -BinaryPathName "<tax-transfer-de-install-directory>\Columba.Api.exe" -Credential "<tax-transfer-de-user>" -Description "Tax Transfer DE Web Application" -StartupType Automatic

      Replacing <tax-transfer-de-install-directory> with the location of the exctracted installation resources.
      Replacing <tax-transfer-de-user> with a Service user account with the format DOMAIN OR COMPUTER\USER e.g., Contose\ServiceUser or the Local Service Account NT AUTHORITY\LocalService. If this parameter is not specified, the local service account is used.
      Learn more about permissions required for the Tax Transfer DE Windows Service or using a Managed Service Account.

    4. Additional configuration steps may be required, as per default, Tax Transfer DE Server will listen to https://localhost:443/. To change this, open the appsettings.json file located at <tax-transfer-de-install-directory> and change the value of the key Urls to a desired listening address(es). Learn more about exposing Tax Transfer DE server. You will also be provided with information how to setup a X.509 certificate for HTTPS protocol.

    5. Start the service with the following PowerShell 6 command:

      Start-Service -Name "Tax Transfer DE"