Equisys technical notes

Technical guidance, explanations and fixes for our products

HOWTO: Updating to Zetafax version 17.5



This Zetafax technical note applies to:

  • Zetafax version 17.1
  • Zetafax version 17.0
  • Zetafax 2014 and earlier systems


This document describes how to update an installed Zetafax system to version 17.5 from an older version.

More information


Before starting the upgrade process, ensure you have the following:

  • An existing Zetafax system, which has been installed with a Zetafax starter licence
  • The Zetafax version 17.5 installation file set, usually downloaded as file ZetafaxInstallSet.exe
  • (If upgrading from Zetafax 2014 or earlier only)  A version upgrade license number for Zetafax version 17 similar to the following:
    • U1234567-V17USER10-ABCDEF

Upgrade the Zetafax Server

Start by upgrading the Zetafax Server.  This upgrades the server programs, and also updates the installation files required to upgrade the client and some other components.

  1. Shut down the Zetafax Server or stop the Zetafax Server service with the Services applet in Control Panel.
  2. Copy the self-extractor program ZetafaxInstallSet.exe to a new folder, then run the program

  1. Choose the destination folder, then click Install to extract the installation files
  2. If the Welcome installation program did not start automatically, start it by running program Welcome.exe from the installation file set folder

  1. Select Install Zetafax > Zetafax Server to run the Zetafax Server Setup program.

  1. Click Yes to confirm that you with to upgrade an existing installation, then Next to start the upgrade process.
  2. Enter the upgrade license number if requested, then continue until the installation completes.

Register the system

Only required if upgrading from Zetafax 2014 or earlier

If you entered an upgrade license number during the step above then you will need to re-register your system using our online registration service.

  1. Run the Zetafax Configuration program, right-click on Licencing and Registration, then choose Modify/Upgrade license details to display the Licence and Registration wizard
  2. Click Next until the Online Registration screen is displayed

  1. Click Register Online to display the Product Registration page in your browser
  2. Enter the registration details, then click Register to submit the details
  3. Your registration code will be emailed to the email address provided on the registration page.
  4. Enter this registration code into the License and Registration Wizard, then click Finish to complete your registration process.

Upgrade the Dialogic Brooktrout drivers

Only required for systems using the Zetafax FoIP Connector (SR140 Edition) or Brooktrout fax boards

  1. Log on to the computer running the Zetafax Server with an account which has local administrator rights on that computer.
  2. Stop the Zetafax Server if running
  3. Using the Services app, stop the Dialogic Corporation Boston Host Service if running
  4. Using Windows File Explorer, create a temporary backup folder then copy the following configuration files from folder C:\Program Files (x86)\Brooktrout\Config to the temporary backup folder:
  1. Using Add/Remove Programs, uninstall the Dialogic Brooktrout Runtime Components if already installed
  2. Run Windows File Explorer, browse to folder zfax\Server\Boston (where zfax is the network share for your Zetafax Server – eg C:\Program Files (x86)\Zetafax Server), then run program Boston.msi to start the Brooktrout Runtime Software setup program.

  1. Follow the instructions to install the Brooktrout software.  Once the installation process has completed, close the Setup program.
  2. Using Windows File Explorer, copy the configuration files saved above to folder C:\Program Files (x86)\Brooktrout\Config, overwriting the files created during the installation.
  3. Now run the Brooktrout Configuration Tool from the Windows Start menu.  The program will display the Preferences screen

  1. Click OK to accept the default locations.  The program will then display the Brooktrout Configuration Wizard.

  1. Click Next to review the settings until you reach the end of the Wizard, then click Finish.
  2. Now start the Zetafax Server.  Confirm that the Brooktrout devices are initialised and start up correctly with no error messages being displayed.

Upgrade the Zetafax SMTP Server

Only required for systems using the Zetafax Email Gateway and Zetafax SMTP Server

  1. On the server that has the Zetafax SMTP Server installed, stop the Zetafax SMTP Server service using the Services app.
  2. Run Welcome.exe from the Zetafax installation file set extracted earlier, then select Install Zetafax > Zetafax Email Connectors > Install Zetafax SMTP Server to run the setup program
  3. Follow the instructions to upgrade the Zetafax SMTP Server program
  4. Using the Services app, restart the Zetafax SMTP Server.  Confirm that the service starts and continues running.
  5. Start the Zetafax Server, then test that you can send and receive faxes using the SMTP mail client as before

Upgrade the Zetafax Web Client

Only required for systems using the Zetafax Web Client

  1. Run program Welcome.exe from the Zetafax installation file set extracted earlier, select Install Zetafax > Zetafax Web Client to display the download page, then download the Zetafax Web Client setup program.  Note that you will need to enter a username and password to access the download – these are the same credentials as you used for the main product download.
  2. On the Windows IIS server hosting the Web Client, run the Zetafax Web Client setup program, then follow the instructions to install the update.
  3. Start the Zetafax Server, then test that you can use the Zetafax Web Client as before

Upgrade the Zetafax Client

The server upgrade copies the Zetafax Client Applications setup programs in the shared folder.  The Zetafax Client checks this folder each time it is run, and will then prompt the user to upgrade.  This requires the user to have administrator rights on their computer.

If your users do not have admin rights then you should upgrade the client manually by doing the following on each client computer

  1. Log on to the computer with an account which has local administrator rights on that computer.
  2. Close the Zetafax Client if running.
  3. Run Windows File Explorer, browse to folder zfax\System (where zfax is the network share for your Zetafax Server – eg \\MyServer\ZFAX), then run program WKSetup.exe
  4. Follow the instructions to update the client components, including the Zetafax Printer and the Zetafax Outlook Extensions

The Zetafax Client Applications can also be updated using Group Policy. Please consult the online help documentation for advice on how to do this.

Custom applications using the Zetafax API

This version of the Zetafax Server is compatible with older versions of the Zetafax API libraries used by custom applications to communicate with the Zetafax Server.  If you are using a custom fax-enabled application, this should continue to work after the upgrade without any further action being required.  Please contact Equisys or the application vendor for further information if required.


ZTN2133-INFO What is new in Zetafax version 17.5

 Last updated: 16th July 2019 (GW/NT)

Equisys Logo, Document Management and Expense Management for Business Central

Replaced by script