Enabling High Availability mode

You can use the hasetup.exe app to add a platform server to a HA cluster or to remove a server from the HA cluster.

Before you begin, stop all the active PSW applications on your Windows machine. The Platform Server for Windows service should also be stopped.

Then open a new command-line interface as an admin and run the hasetup.exe application with one of the following options:

  • To convert to HA mode, run the following command:

    hasetup.exe install "\\shared.mycompany.com\mftps\haRoot"
  • To convert from HA mode, run the following command:

    hasetup.exe uninstall "\\shared.mycompany.com\mftps\haRoot"

The following are the available parameters for hasetup:

Mandatory hasetup parameters

Parameter Name Parameter Description
Install Defines that PSW will be converted to HA Mode. Either the install or uninstall parameter must be defined.
uninstall Defines that PSW will be converted from HA Mode to non-HAmode. Either the install or uninstall parameter must be defined.
path_to_HAConfig directory Defines the path of the HAConfig directory. This directory is shared by the Primary and Secondary PSW servers. The Primary and Secondary PSW servers must have read and write access to this directory. If there are any spaces in the directory name, it should be enclosed in double-quotes.

Optional hasetup install parameters

Parameter Name Parameter Description
noPrompt You will not be promoted for optional parameters. Default options will be used if the command line parameters are not defined.
copyConfigFiles Copy configuration files from your local PSW configuration into the HA directory configuration only if there are no configuration files in the HA directory. If configuration files exist in the HA directory, they will not be replaced.
copyTrnNumber Copy the local transaction number from your local PSW into the HA directory configuration only if there is no transaction file in the HA directory. If the transaction file already exists, it will not be replaced.
copyLogFiles Copy audit log files from your local PSW configuration into the HA directory configuration only if there are no log files in the HA directory. If log files exist in the HA directory, they will not be replaced.
copyPqfFile Copy the ftmssvr.pqf file from your local PSW into the HA directory configuration only if there is no PQF file in the HA directory. If the PQF file already exists, it will not be replaced.
replaceConfigFiles Copy configuration files from your local PSW configuration into the HA directory configuration. If the files exist, they will be replaced. If the files do not exist, they will be created.
replaceTrnNumber Copy the local transaction number from your local PSW into the HA directory configuration. If the file exists, it will be replaced. If the files do not exist, they will be created.
replaceLogFiles Copy audit log files from your local PSW configuration into the HA directory configuration. If the files exist, they will be replaced. If the files do not exist, they will be created.
replacePQFFile Copy the ftmssvr.pqf file from your local PSW configuration into the HA directory configuration. If the file exists, it will be replaced. If the file does not exist, it will be created.
Note: If the copy and replace parameters are not defined, then no files will be created in, or copied to, the haRoot folder. PSW will function as if it is a new installation.

Optional hasetup uninstall parameters

Parameter Name Parameter Description
noPrompt You will not be promoted for optional parameters. Default options will be used if the command line parameters are not defined.
copyConfigFiles Copy configuration files from the HA directory to your local PSW configuration only if there are no configuration files in the HA directory. If configuration files exist in your local PSW configuration directory, they will not be replaced.
copyTrnNumber Copy the local transaction number from the HA directory to your local PSW configuration only if there is no transaction file in the local PSW directory. If the transaction file already exists, it will not be replaced.
copyLogFiles Copy audit log files from the HA directory to your local PSW log directory only if there are no log files in the local PSW log directory. If log files exist in the local PSW log directory, they will not be replaced.
copyPqfFile Copy the ftmssvr.pqf file from the HA directory to your local PSW configuration only if there is no PQF file in the local PSW directory. If the PQF file already exists, it will not be replaced.
replaceConfigFiles Copy configuration files from your HA directory to your local PSW configuration. If the files exist, they will be replaced. If the files do not exist, they will be created.
replaceTrnNumber Copy the local transaction number from the HA directory to your local PSW configuration. If the file exists, it will be replaced. If the file does not exist, it will be created.
replaceLogFiles Copy audit log files from the HA directory to your local PSW log directory. If the files exist, they will be replaced. If the files do not exist, they will be created.
replacePQFFile Copy the ftmssvr.pqf file from the HA directory to your local PSW configuration. If the PQF file exists in your local PSW directory, it will be replaced. If the PQF file does not exist, it will be created.
Note: If the copy and replace parameters are not defined, then no files will be created in or copied to the local PSW folders.

After you run the hasetup.exe app and added a server into the HA cluster, you can restart Platform Server. In the ftmsmgr.exe app, you will see a new entry appear on the Server Property page, "Ha Setup", with the haRoot folder path. This confirms that now the server runs in HA mode. The server that has been restarted first will become the Primary HA Server.

All other Platform Server for Windows applications are also HA aware and use configuration entries from the haRoot folder.

Example 1:

hasetup.exe install \\shared.mycompany.com\mftps\haRoot copyConfigFiles replacePqfFile

In example 1:

  • Current configuration files are copied to HA setup only if there is no configuration files in HA setup already

  • Current ftmssvr.pqf is copied to HA setup

  • Current log files will not be copied to HA setup

  • Current transaction number will not be copied to HA setup

Example 2:

hasetup.exe install \\shared.mycompany.com\mftps\haRoot noPrompt

In example 2:

  • Current configuration files will not be copied to HA setup

  • Current ftmssvr.pqf will not be copied to HA setup

  • Current log files will not be copied to HA setup

  • Current transaction number will not be copied to HA setup

  • No prompts

  • 0 returned on success

  • 8 returned on failure

Example 3:

hasetup.exe uninstall \\shared.mycompany.com\mftps\haRoot copyConfigFiles replacePqfFile replaceTrnNumber

In example 3:

  • PSW is moved out from HA setup, back to the regular single-server setup

  • Current configuration files are copied from HA setup to the "MFT Platform Server" folder only if there are no configuration files in "MFT Platform Server" already

  • Current ftmssvr.pqf from HA setup will be copied to the "MFT Platform Server" folder

  • Current log files will not be copied from HA setup to the "MFT Platform Server\Trace" folder

  • Current transaction number from HA setup will be copied for regular, non-ha setup

Note: Every time you run hasetup.exe a trace file is created in the PSW Trace folder in the following format: Hasetup[Install | Uninnstall]_date@time.txt

Example: HaSetupInstall_1.3.2024@17.41.13.txt