How do I update my Eclipse Payroll software?

Modified on Tue, 25 Jun at 11:24 AM

Its recommended you keep your Eclipse Payroll software up to date. It is easy to do this using the Software Updater screen in Eclipse which manages downloads and helps you install them.

To allow for this functionality you must first set the Updates Folder setting used to store the downloaded Update files. This is done in System Options or from the Software Updates screen itself.


Please Note: If you're an ex-AADS customer using the VPN this information does not apply to you as Updates are managed for you. (Relates to version 9.6 of Eclipse Payroll or later)

System Options

To allow Automatic updates to your Eclipse Payroll software you must enable this in System Options first.

The critical step here as far as accessing Software Updates goes, is to ensure that the location set for the Update Folder is the same for all users and that all users can access it.

Each User shares this setting, so it is best to use a network location or Shared folder somewhere that everyone has least Read access to (e.g. \\MYSERVER\EclipsePayroll\Updates\). 

Doing so will allow users to quickly upgrade their Payroll using the same Update MSI File as the person who updated the Database.

This is useful because as soon as a User downloads and applies a new version, all other users must upgrade to it before they can login next.

You can also tell the software to prompt you when a new version is available by setting the Check for Update on Startup checkbox. The prompt will pop up a notification in your Windows System Task Bar when you load Eclipse Payroll if a new Version is available for Download.

You can also select the Stamp current version checkbox to stamp the current version as available for other users to install from the Update Folder. This only needs to be done once and note that this get stamped automatically when future Database upgrades occur.

Checking for and downloading the latest Eclipse Payroll Update

You can check for a new Eclipse Payroll release at any time when using the software by selecting the Check for Update function on the Help Menu, as shown below:

In this case the Update Folder is set to a valid Location and hence the screen has loaded and immediately placed the User on the Download tab:

If the Update Folder location is invalid or not set, the screen will open and place the User in the Setup tab:

If this occurs, the User will need to correct the Update Folder setting so that a Download can proceed.

After setting a valid location for the Update Folder and then pressing the Save button the user will be moved to the Downloads tab so they can download the latest release.

Managing Software Updates for all Users

Eclipse Payroll is typically installed so that each User will need to upgrade their software separately.

It is recommended that applying Eclipse Payroll Updates is coordinated amongst all Users and that each User upgrades their software at the same time.

When you upgrade the software for Eclipse Payroll, note that normally the Database will be Upgraded also when you first run that new version of the Software against it.

If this database upgrade occurs, all other Users of Eclipse Payroll will find that when they login next, they cannot do so because the Eclipse Payroll software they are using is no longer compatible with the upgraded Database.

So for these types of Releases all Users must upgrade if they wish to continue using the system.

Even if the database is not upgraded by a given Update (which can happen), it is still a good idea to keep everyone on the same Version.

If a User logs in to Eclipse Payroll after the Database has been Upgraded by a different User then their software will no longer be compatible with the Database and the system will prompt the User to fix this as shown below:


Pressing No at this point will exit Eclipse Payroll.

Pressing Yes will load the Software Update screen so the user can address this problem.


The Update screen can open in one of three ways in this mode as follows:


1. When the Update MSI File is found in Update Folder

If the Update Folder is accessible to the current User AND the System can locate the Update File used to upgrade the Database, then the Update Screen will automatically use this Update File and will place the User in the Install tab so they can quickly install it.

The User will not need to Download the Update as they will reuse the update in the Update Folder which was downloaded by the user who upgraded the database.

The User can either Install the Update or Open the Update Folder.

If they choose to run the Installer - then Eclipse Payroll will automatically close and then launch the installer program for the Update chosen.

If they choose to open the Update Folder then they will be prompted to close Eclipse.

Eclipse Payroll must be closed to run the Update installer program.

2. Update MSI File not found

If the System cannot locate the relevant installer MSI file then the user will get the chance to download it themselves. The system will place them in the Download tab:

The User can check the UBS Update Server by clicking the Download Update button.

If a new Release is found and Downloaded successfully the user will then be transferred to the Install Tab so they can install it.

3. Incorrect Setup

If the Update Folder has not been set or it is invalid, the User will be placed in the Setup Tab so they can fix this before progressing.

Note that if they correct the issue and an appropriate Installer MSI file can be found in the Update Folder then the User will be placed in the Install Tab so they can install it when they press Save.

If no MSI is found, they will be placed in the Download Tab once they Save.


Update Installer Program

When run the Payroll Update Program prompts the User to upgrade their Eclipse Payroll software.

Simply follow the instructions.

Once successfully upgraded, you will need to reopen Eclipse Payroll.


Rolling Back a Version

If you need to rollback to an earlier version of Eclipse Payroll, follow these steps to do so.

  1. Locate the Uninstall program for Eclipse Payroll in you Start Menu under the Eclipse Payroll sub-menu.
  2. Run it to remove the current software version of Eclipse Payroll.
  3. Locate the Updates Folder and run the Update MSI file for the version you wish to revert to.
  4. Run Eclipse Payroll.

These steps need to be repeated for each User.

Was this article helpful?

That’s Great!

Thank you for your feedback

Sorry! We couldn't be helpful

Thank you for your feedback

Let us know how can we improve this article!

Select at least one of the reasons
CAPTCHA verification is required.

Feedback sent

We appreciate your effort and will try to fix the article

Click here to leave feedback or comments