The Claris FileMaker Upgrade Tool is a command-line utility for applying changes to an existing FileMaker custom app.
It can update elements such as the database schema, layouts, and scripts by applying an XML patch file to a FileMaker file. Its purpose is to help developers distribute controlled application updates without necessarily replacing the customer’s entire production file.
The FileMaker Upgrade Tool should not be confused with the FileMaker Data Migration Tool. Although both tools can be part of a FileMaker deployment strategy, they address different situations.
Updating an existing FileMaker app
A FileMaker custom app often contains both the developer’s application and the customer’s production data. Over time, the production version may also acquire customer-specific layouts, fields, scripts, or other modifications.
This can make upgrades more complex. Replacing the file with a new version would also replace its data, accounts, and potentially some customer-specific changes.
The FileMaker Upgrade Tool takes another approach: it applies a defined set of changes directly to the existing file.
A developer can use it to distribute changes such as:
- Adding or modifying database objects
- Updating layouts
- Updating scripts
- Correcting an urgent problem
- Applying a temporary debugging modification
- Removing debugging components after an issue is resolved
Because the changes are described in a patch, the update can be repeated in a controlled and consistent manner.
A tool for patches rather than complete releases
The FileMaker Upgrade Tool is particularly well suited to focused updates between major releases.
For example, if a deployed application requires a critical script correction or a small addition, creating a patch may be more practical than preparing and deploying an entirely new application file.
However, it is not necessarily the best choice for every upgrade. The patch must be prepared carefully, and some changes are more appropriate for a full application release.
For major upgrades, the usual approach is often to create a new FileMaker file containing the complete new version of the application, then use the FileMaker Data Migration Tool to transfer the production data and accounts into it.
In simplified terms:
- The Upgrade Tool modifies the application objects in an existing production file.
- The Data Migration Tool moves production data into a new version of the application.
The right choice depends on the scale of the changes, the way the application is distributed, and whether customers are allowed to customize their own copies.
How are upgrade patches created?
The Upgrade Tool uses an XML patch describing the required changes.
Developers can use FileMaker’s XML representation of two versions of an application to identify what has changed, then construct the appropriate patch. The process requires a good understanding of the structure of the FileMaker application and of the dependencies between its objects.
The tool does not automatically turn every difference between two files into a production-ready patch. Creating and validating the patch remains part of the developer’s release process.
This makes the Upgrade Tool especially valuable for professional FileMaker product developers, solution publishers, and organizations maintaining multiple deployed copies of the same custom app.
Part of a professional deployment strategy
A reliable FileMaker upgrade is not simply a file operation. It involves backups, validation, compatibility testing, user communication, rollback planning, and verification after deployment.
At fmcloud.fm, we help FileMaker developers and organizations design deployment procedures appropriate to their applications. Depending on the project, this may involve the FileMaker Upgrade Tool, the Data Migration Tool, OttoFMS, the FileMaker Developer Tool, or a combination of these technologies.
Our objective is to make upgrades repeatable and predictable while protecting production data and minimizing service interruption.
