Updating a FileMaker Cloud custom app

If you have made schema, layout, or other changes in an app, you can update the hosted app with the changes. To do so, create a clone of the changed file, then use the Update API call to update the original file based on the changes in the modified app. The Update API call moves all record data and user accounts from an app hosted by FileMaker Cloud to a clone, then replaces the original file with the target file. The target file includes all data from the source file and all the schema, layout, and other changes from the clone.

For example, use the Update API call to:

  • copy test data or live data into a custom app between different stages of the DTAP (Development, Testing, Acceptance, and Production) cycle

  • copy existing data into a new version of a custom app

Advantages of using the Update API call, instead of importing data, include:

  • you move all data at once, instead of importing data from each table separately

  • the API call maps fields between source and target tables automatically, instead of you mapping them manually for importing

  • you can update user accounts, custom value lists, and serial numbers, which you can't do when you import data

Terms used for the updating API topics:

  • source file: An FMP12 file that contains the data to use for the target file.

  • file to be cloned: A file that includes tables, layouts, scripts, and field definitions to use for the target file. This file can be the same as the source file, or it can be a different file. For example, if you use the Update API call between different stages of the DTAP cycle, the file to be cloned could be in the testing stage while the data to use could be in the production stage.

  • clone: A copy of an FMP12 file that contains all the tables, layouts, scripts, and field definitions but none of the data. Use FileMaker Pro to make a clone, but don't open the clone. Opening a clone modifies it.

  • target file: A copy of the clone created by the Update API call, into which data and user accounts from the source file are migrated. The Update API call replaces the original source file with the target file.

Before you begin

  • If the account for accessing the source file or the clone doesn't have the Full Access privilege set, create a new extended privilege, called fmmigration, for the account. See FileMaker Pro Help.

    • The keyword for the extended privilege must start with the fmmigration prefix. The account with this extended privilege doesn't need to have access to any tables, scripts, or layouts. The source and clone extended privilege names must match (but are not case sensitive).

  • Both the source file and the clone must be encrypted. The encryption passwords can be different.

  • Make sure you know the account name, password, and encryption password (if encrypted) for the source file and the clone.

Create a clone

Create a clone of the file that includes tables, layouts, scripts, and field definitions to use for the target file.

  1. In FileMaker Pro, open the file to be cloned.

  2. Choose File menu > Save a Copy As, then choose clone (no records).

    3. Important  Do not open the clone with FileMaker Pro.

  3. Make sure the source file is closed.