Installing on Windows

This section describes how to actually install the Avantra Server.

We recommend installing the Avantra Server and Avantra WebUI on the same host, although the installer allows you to install them separately. We advise contacting the Avantra Support team if you plan to install the Avantra Server and Avantra WebUI on separate hosts.

If there are any issues during the installation and you need to do the root cause analysis, you can find the log files in %TEMP%/Avantra Installation Logs.

Installing the 64-bit Java Runtime Environment (on Microsoft Windows operating systems)

The Avantra Server only runs on a 64-bit Microsoft Windows operating system and requires a 64-bit Java 17 Runtime Environment.

If you do not have a suitable 64-bit Java 17 Runtime Environment installed, see Avantra and Java for more information.

Installing the Microsoft SQL Server

You can skip this step if you already have installed a Microsoft SQL Server or use a remote one. In this example, the Express Edition is installed.

Perform these steps on the server supposed to host the Avantra Database, either the Avantra Server or a dedicated database host.

Procedure: Installing Microsoft SQL Server Express Edition

  1. Download the latest Microsoft SQL Server Express Edition (e.g. Microsoft SQL Server 2019 Express Edition) from this location and save the file locally, e.g. to C:\Downloads.

  2. Open the recently downloaded file (e.g. SQLServer2019-SSEI-Expr.exe):

    1. Choose Download Media.

    2. Choose Express Core and – if desired – change the download location to e.g. C:\Downloads.

    3. Push the Download button.

    4. Push the Close button.

  3. Open a command prompt and switch to the directory chosen in Step 2b.

  4. Run the following command:

SQLEXPR_x64_ENU.exe /ACTION=Install /AddCurrentUserAsSQLAdmin
/FEATURES=SQL,Tools /IAcceptSQLServerLicenseTerms /QUIETSIMPLE
/SQLSVCACCOUNT=SYSTEM /SQLSYSADMINACCOUNTS=SYSTEM /TCPENABLED=1
/INSTANCENAME=MSSQLSERVER /SQLSVCSTARTUPTYPE=Automatic
/SECURITYMODE=SQL /SAPWD=+XandriA123456789!

Please adapt the value for SAPWD to set the default password for the sa login.

This procedure describes the most convenient way to install Microsoft SQL Server.

The only requirements Avantra has are the following: a user (either Windows user or an SQL user) has the permission to be the owner of an Avantra Database; access the database using TCP/IP. You should be familiar with the database security models and policies of your organization and we highly recommend adapting the command line call above accordingly or perform a plain installation and change the settings afterwards using SQL Server Management Studio (SSMS) and/or SQL Server Configuration Manager.

For more information, refer to the SQL Server Technical Documentation.

For an explanation of the command-line options, refer to Install SQL Server from the Command Prompt.

For more information on how to schedule and automate backups for the Microsoft SQL Server Express Edition, refer to How to schedule and automate backups of SQL Server databases in SQL Server Express

Verify TCP/IP Settings of Microsoft SQL Server

You can skip this section if you have already performed all the steps in Installing the Microsoft SQL Server.

If you have already installed a Microsoft SQL Server (Microsoft SQL Server 2012 or higher) or you are performing a shared installation, please make sure to enable local and remote TCP/IP connections.

Open the SQL Server Configuration Manager, choose SQL Server Network Connections  Protocols for [instance_name], and set the Status for TCP/IP to Enabled.

Running the Avantra Server Installer

Procedure: Running the Avantra Windows Installer

  1. Download avantra-server-24.0.n-win64.exe from the Avantra Customer Hub.

  2. Open the installer, push Next on the welcome screen and accept the license using the I agree option on the license screen.

  3. You are asked to install either the Avantra Server, the UI, or both. Usually you will leave the default and install both. Push Next to continue.

  4. Choose an appropriate installation location and push Next.

  5. Choose the ports for incoming HTTP and or HTTPS connections of the web UI. You may push the Verify Ports button in order to check if the ports are free. Press Next.

  6. Verify the Windows Firewall configuration rules that will be added/updated in your system. Press Next to proceed.

  7. Choose the (Windows) user to run the Windows services as. If you use Windows Authentication for the Microsoft SQL Server (which is the default in Step 4 of the Procedure: Installing Microsoft SQL Server Express Edition), make sure you use the same user here as for the Microsoft SQL Server.

    If you did not change the command in Step 4 of Procedure: Installing Microsoft SQL Server Express Edition, leave it to the default LocalSystem here. If your Microsoft SQL Server is running with a different user, fill in the same user. Press Next to proceed.

  8. Push Install.

  9. On the final screen, make sure you have checked Install UI and Server and push Finish.

Staging the Avantra Database (on Microsoft Windows operating systems)

  1. Open your browser at http(s)://localhost:[port] (with the port as defined above)

  2. Choose Microsoft SQL Server and push Next.

  3. The local server is searched for SQL Server instances. Select an appropriate value from the drop-down list (there will be usually only one). If you need to connect to a different Microsoft SQL Server, fill in Host / Port and Instance Name. Push Next.

  4. Choose Windows Authentication if you want to access the Microsoft SQL Server using this security model. Otherwise, define an SQL User / Password. Push Next.

  5. Define a name for the database. You will usually leave this to the default value avantra. Push the Create Database & Check button.

  6. Define the application root user. Fill in values for Root user name and Root user password and push the Create button.

    Note down these credentials carefully and keep them at hand. For the time being, this will be the only way to access the application!

  7. Push Save and switch to Avantra UI to finish the installation.