Windows installation

This topic describes how to perform an installation of Connect on Windows and how to upgrade an existing installation. Make sure to review the planning documents described in Concepts.

Before you install

For all installation types, perform the following steps before you install the product:

  1. Check the Support Matrix.
  2. Before installing , make sure you have a PostgreSQL database server installed on the machine. See PostgreSQL database for more details.
  3. Download Connect Core for Windows from the AppDelivery Marketplace.
  4. Extract the installer file from the downloaded archive, mfconnect-<version-OS_Info>.exe. Double click the installer .exe file.

Back to top

Perform a full Windows installation

This section describes how to perform an on-premises installation.

To install the product:

  1. On the Installation's opening page, choose Full installation. Click Next to move through the installation wizard.
  2. In the wizard's Database Connection Options page, select one of following depending on your PostgreSQL database configuration:

    • Connect to an existing database. Select this option if you are using PostgreSQL database initialization. In this case you have to manually create the database. For details, see Create database manually.

    • Create new database by admin user. In this case, provide the PostgreSQL admin user credentials and admin database to establish the required admin session.

    Note: If you are using Windows Server, restart your computer after the installation is complete. This ensures that all environment variables are properly set for Connect.

  3. Open the Windows Services app, select the Connect Web Server service, and click the Start button.

  4. Go to the URL provided to you, and log in with your credentials.

Back to top

Secure the connection to the database server

You can secure the connection from the Connect server to the PostgreSQL database server with encryption and two-way authentication.

The PostgreSQL server and client can operate in various SSL modes. For details, refer to the official PostgreSQL documentation, in the section "Configuring the Client."

To secure your connection with the PostgreSQL server:

  1. Obtain a PostgreSQL Server SSL/TLS certificate.
  2. Configure the security properties for the connection from the Connect server to the PostgreSQL server in the AppData/data/database.properties config file, by setting the ssl.mode property.

    We strongly recommend using verify-full as the value for this property.

    You can see all the possible values in the PostgreSQL documentation for the sslmode JDBC property.

  3. Establish a trust relationship between Connect and PG server SSL certificate. For details, see Install SSL certificates.

  4. If the PostgreSQL server is configured to validate client certificates, perform the following steps:

    1. Obtain a Connect key and certificate for the connection to the PostgreSQL server.

    2. Establish a trust relationship between the PostgreSQL server and the Connect server certificate. For details, refer to the PostgreSQL documentation on client certificate validation.

    3. Prepare the PKCS12 keystore with the PostgreSQL client key and certificate.

    4. Run the Connect server with JVM options that specify a keystore with the Connect server key, for connection with the PostgreSQL server:

      -Djavax.net.ssl.keyStore=/path/to/KeyStore

      -Djavax.net.ssl.keyStorePassword=KeyStorePassword

Back to top

Increase maximum allocated memory

A standard installation is configured to run with 8 GB of memory. As the number of connections and usage grow, you may require more memory.

The following procedure describes how to increase the Tomcat maximum allocated memory on Windows deployments.

To increase the allocated memory:

  1. Open a command prompt window as an administrator in the <MFConnect_installdir>\WebServer\bin folder.
  2. Run the command tomcat9w.exe //ES/ConnectWebServer. This launches the Web Server Properties dialog box.
  3. Select the Java tab.
  4. In the Maximum memory pool box, change the value to reflect a reasonable percentage of the available memory on the machine. For example, on a 16 GB machine change the value to 12288 MB (12 GB). On a 32 GB machine, change the value to 28672 MB (28 GB).
  5. Click OK.

Back to top

Set the locale to English

To run synchronizations, you must configure your operating system to the US English locale.

The following procedure describes how to set the locale to US English on a Windows machine. This applies to both new installations and upgrades.

To set the locale to English:

  1. Open a command prompt window as an administrator in the <MFConnect_installdir>\WebServer\bin folder.
  2. Run the command tomcat9w.exe //ES/ConnectWebServer. This launches the Connect Web Server Properties dialog box.
  3. Select the Java tab.
  4. Append the following to the bottom of the Java settings area. Add them to the upper area—not the bottom Java 9 Options area:

    -Duser.language=EN

    -Duser.country=US

  5. Select the General tab.

  6. Click Stop to stop the service.

  7. Click Start to restart the service.

  8. Click OK.

Back to top

Migrate to a new machine

This section describes how to migrate an installation to a new machine.

Note: If the PostgreSQL database was installed on the same machine as Connect, it needs to be moved as well. See the official PostgreSQL documentation on how to move the database to another machine.

On the source machine:

  1. Stop all running connections.
  2. Run C:\Program Files\Micro Focus\Connect\Utilities\mfcpurge.bat as an administrator.
  3. Open services.msc and stop the Connect Web Server service.
  4. Right click the service and click Properties. Select Disabled and click OK. This prevents simultaneous writing to endpoints from two instances.
  5. Compress C:\Program Files\Micro Focus\Connect\AppData and all its contents into a zip file.
  6. Open a command prompt as an Administrator and run <MFConnect_installdir>\WebServer\bin\tomcat9w.exe //ES/ConnectWebServer
  7. Go to the Java tab. Copy all of the contents in the Java Options section and paste into a text file. Save the file.
  8. Note the value of the Maximum Memory Pool.
  9. Back up <MFConnect_installdir>\jre\bin\security\cacerts.
  10. Refer to the server.xml file to see if your connection was set up to be secure. If you had made modifications to secure Connect with SSL, then back up <MFConnect_installdir>\WebServer\conf\server.xml and all certificate files that were in use.
  11. Back up the contents of <MFConnect_installdir>\war.

On the target machine:

  1. Download and install the same build of Connect used on the source server.
  2. Copy the files you saved from the source machine to the target machine.
  3. Delete the <MFConnect_installdir>\AppData folder and replace it with the copy from the source machine.
  4. Open a command prompt as an Administrator and run <MFConnect_installdir>\WebServer\bin\tomcat9w.exe //ES/ConnectWebServer
  5. Go to the Java tab.
  6. Paste of the contents of the Java Options box that you saved to a text file above (step 7), into the Java Options section. Make sure to paste them into the Java Options section and not the Java 9 Options section.
  7. If the target machine has the same memory installed as the source machine, adjust the Maximum Memory Pool to match the source's value. If the machine has less memory, request that it be increased. If the machine has more memory than the source machine, it can be increased further. Check the Task Manager on the target machine to see how much memory is available on the machine.
  8. Overwrite <MFConnect_installdir>\jre\bin\security\cacerts with the source machine version, from step 9 above.
  9. If you have an SSL Secured deployment, overwrite <MFConnect_installdir>\WebServer\conf\server.xml with the copy from the source machine in step 10. If you saved any certificate files, copy them over too.
  10. Overwrite the contents of <MFConnect_installdir>\war with the files saved from the source machine in step 11 above.
  11. Open services.msc and start the Connect Web Server service.
  12. Log in and start the connections.

Back to top

Uninstall

To uninstall Connect, use the uninstall feature from the Windows Control Panel.

The uninstall process does not delete the repository, log, and configuration directories, in case you want to reinstall. Delete them if necessary.

Back to top

Next steps: