Skip to main content

Upgrading to the Latest Major Version

Table of Contents:

Upgrading to the Latest Major Version

To upgrade to the latest major version of MirrorSync, follow the steps below. Only the installer step is required immediately, the remaining steps can be completed later, but should be done soon to ensure optimal performance and long-term compatibility.

Before you start​

  • Be certain that your MirrorSync license is up to date. You can check that here; to find your key and "Registered to" name, you can click the licensing button in your configuration client. If your license is not up to date, you will not be able to sync with MirrorSync 7; renew your license prior to upgrading.
  • Be aware that before the first time you sync after upgrading to a new major version, MirrorSync will attempt to upgrade the internal sync data database to prepare it for the new version. Usually this operation takes a few minutes, but upgrading large sync data databases with this operation can take a couple of hours. Depending on the version of MirrorSync you're using, during this time your configuration client may not display a status message. During this time, the sync will be paused, but it has not failed — please allow the process to complete before closing the client.
    • This should occur once for every hub database that your server syncs

1. Run the Installer​

Run the latest MirrorSync installer on every server involved in the sync. This includes the syncing server, the hub server (if it's separate from the syncing server) and any FileMaker spoke servers.

2. Update MirrorSync Scripts (soon after)​

After installing the newest version, you should be able to continue syncing without doing anything else. However, you should replace the script named MirrorSync 6 worker that's in your hub solution soon.

Replace the MirrorSync 6 worker script with the new one from the MirrorSync Support.fmp12 file (included with the installer package download), and set it to run with full access privileges. This step is recommended to ensure optimal performance — older worker scripts will still allow syncing, but with reduced efficiency.

The MirrorSync 6 (<yourConfigName>) script only needs to be updated if you've customized it in the following sections:

  • DidInsert
  • WillUpdate
  • DidUpdate
  • WillDelete

If you do have customizations in those sections, or plan to add some, review the IMPORTANT X.x update notes.txt file that comes in the MirrorSync installation package.

Note:

Spoke databases do not need to have their scripts updated immediately, even if you've updated the hub scripts. They can continue to sync using older scripts and be updated at any point in the future (such as when you're using the MirrorSync versioning feature to replace the spoke database). However, updating them soon is recommended for improved performance.

Note:

This step is optional, but recommended to ensure you're using the latest layout elements and user interface improvements. It will not impact performance or function.

To update the layout used for sync operations:

  • Go to the layout named "MirrorSync" in your FileMaker file.
  • Do not delete the layout, but delete all layout objects on it.
  • Open the MirrorSync Support.fmp12 file included with the installer.
  • Copy all objects from its "MirrorSync" layout and paste them into your now-empty layout.

If you need help or have questions during the upgrade process, please contact 360Works support; we’re happy to assist.