Knowledge Base

New SunLync Updater Information and Configuration

Article ID: 656
Last updated: 17 Oct, 2018
Revision: 2
print  Print
comment  Add comment
Views: 352
Comments: 0

New SunLync Updater Information and Configuration


Beginning in version, users will have the ability to use SunLync's new upgrade distribution process. When enabled, workstations using the process will target the SunLync client version associated with the version of the SunLync database that the client is currently connected to. The needed files to perform the upgrade/downgrade will be automatically downloaded on the client workstations and the user prompted to allow SunLync and related services to restart to complete the upgrade.

The process is designed to allow administrators to upgrade only the server and allow all other workstations to automatically download the needed update after detecting the change, eliminating the admin's need to apply the update to each workstation themselves.

Installation and Enabling the Feature

Beginning in SunLync Select v9.1.0.0 the necessary files for the new upgrade process will be packaged with the SunLync Installer, patch, and SUpdate scripts. If you are upgrading from a version prior to it is important that you upgrade using the SunLync installer to allow the upgrader program to be added to the startup files for that computer.

  1.  Install SunLync v9.1.0.0 or above on the server.
  2. Enable the upgrade service for your organization in Corporate Utility.


      3.  Install SunLync v9.1.0.0 or above on all workstations.

      4.  Ensure that sunUpg.exe is running on all workstations. You'll see this running in your system tray. (This will show up after the computer restarts, or you can start it from the SunLync folder.)


      5.  Ensure that OfflineDownloadService.exe is installed and running on all workstations.

Each workstation will begin to "check-in" hourly to ensure that they are running the correct version of SunLync. When a version conflict is detected, the files needed for upgrade will be downloaded and the user of the workstation prompted to allow the upgrade to complete. Please see the next section for a more detailed look at the process.


The upgrade process is handled by two programs.

  • OfflineDownloadService.exe detects version conflicts, checks all local SunLync files against a remote database of file versions, and downloads the correct versions of any files who's versions have changed in the target SunLync version. This process happens once per hour unless the service has already downloaded an update that hasn't yet been applied. Logging for these functions can be found in \ProgramData\SunLync\Logs\OfflineDownloadService[date].log
  • SunUpg.exe is a Tray Application that creates a notification when an update is ready to be applied, stops all SunLync services and closes SunLync, replaces the files in \Program Files (x86)\SunLync\ with the updated versions downloaded by OfflineDownloadService.exe, restarts any services and SunLync.exe, and provides a front end for users trigger upgrade checks and downloads themselves if they do not wish to wait until the next time that OfflineDownloadService.exe detects version change.


SunUpg.exe is the program responsible for applying the updates downloaded by OfflineDownloadService.exe. When installed using SunLync_Setup_9.*.*.*.exe ( or later) the program will be added as a startup program to Windows to ensure that SunLync is still monitoring for updates after a restart.

Most of the time SunUpg.exe will run silently in the System Tray waiting to prompt the user for an available upgrade.

Notice that Current (client) and Target (server) versions match and that the only option available is "Check For Upgrade". "Check For Upgrade" in this case would trigger a file version check by OfflineDownloadService.exe, even though Current and Target versions match.

Notice also the Download Window start and end times. This is the period in which OfflineDownloadService.exe will download any files needed. This option is set per workstation.

If there is a conflict between Current and Target versions and the download of the new version has not started yet, you'll see something like this:

"Check For Upgrade" in this situation would start the version check and download the files needed to downgrade this workstation to v9.0.4.6. This would happen automatically the next time OfflineDownloadService.exe checks in.

If the user was to click "Check For Upgrade" to start the file check manually, SunUpg will display "Upgrade Available" and the "Download Now" button will be enabled.

After clicking "Download Now", "Download Started" will be displayed.

At this point, the app can be minimized while the updates download. The user will be prompted when the update is ready to be applied.

Once an update has been downloaded and is ready to be applied, regardless of whether the user forced the check with SunUpg or if it was downloaded automatically by OfflineDownloadService.exe, a System Notification will be displayed indicating that updates are ready to be applied.

The user must then open SunUpg.exe by clicking on the try icon and select "Process Upgrade".

This will cause SunLync to close, all SunLync services to stop, the new files to be copied to their appropriate locations, and SunLync and all SunLync services to restart.

The upgrade/downgrade is now complete.

Back Office Monitoring and Control

To assist in monitoring and controlling updates remotely, the Upgrade Portal has been added to the Reports tab.

In order to gain access to the Upgrade Portal, the user must have the "Upgrade Service Portal" permission in the Reports section of Security Templates.

Listed in the upgrade portal will be all SunLync clients currently connected to the database with OfflineDownloadService.exe installed and that have checked in at least once. If there is a workstation missing from this list, the most likely reason is that OfflineDownloadService.exe either is not installed or has not yet checked in (first check in will happen one hour after installation).

Allow Upgrades - When selected, this computer will be able to use the new upgrade process. Use this option to disable upgrading on computers that need to stay on a specific version.

IP Address - The local IP address of the workstation.

Workstation Name - The Windows computer name of the workstation.

Store Location - The SunLync store that the workstation is logged into.

Version - The current client version of the workstation

Latest Update - The date that the workstation was last updated.

Download Status - Indicates if the files needed for updating have finished downloading.

Update Status - Indicates if the workstation has finished the update process.

File Check - The status of a forced file check on that workstation.

The "Force File Check" button will put the currently selected workstation in a status causing it to check that all file versions are up to date regardless of a conflict between client and server versions. This check will happen the next time that OfflineDownloadService.exe on that workstation checks in. "Force File Check For All" simply does this for all workstations on the list.

If you are experiencing issues not not addressed in this article or need further assistance, please contact the SunLync Support Team.

This article was:   Report an issue