Claris FileMaker Developer Tool Guide

Submit Search

Command-line parameters

Note Before you run the developer tool on a source file, be sure the source file is closed.

Usage: FMDeveloperTool <Subcommand> [<other options>]

Subcommands

Description

‑‑help

Displays help.

‑‑version

Displays the version of the developer tool (major.minor.update.build). The major version number corresponds to the Claris FileMaker Platform version. The other numbers describe the specific version of this tool.

‑‑copy

Creates a copy of an FMP12 file that contains all the tables, layouts, scripts, field definitions, and all of the data with these options:

Options	Description
source_filename	File path of the source FileMaker Pro file.
username	Source file account user name. Defaults to 'Admin', if not entered, and will be used to sign in.
password	Source file account password. Defaults to blank, if not entered, and will be used to sign in.
‑target_filename	File path of the newly generated target FileMaker Pro file.
‑encryption_key	EAR (encryption at rest) password of the source file.

Note This command requires the Allow exporting privilege.

‑‑clone

Creates a copy of an FMP12 file that contains all the tables, layouts, scripts, and field definitions but none of the data with these options:

Options	Description
source_filename	File path of the source FileMaker Pro file.
username	Source file account user name. Defaults to 'Admin', if not entered, and will be used to sign in.
password	Source file account password. Defaults to blank, if not entered, and will be used to sign in.
‑target_filename	File path of the newly generated target FileMaker Pro file.
‑encryption_key	EAR (encryption at rest) password of the source file.

Note This command requires the Allow exporting privilege.

‑‑copyCompress

Creates a compressed copy of an FMP12 file that contains all the tables, layouts, scripts, field definitions, and all of the data with these options:

Options	Description
source_filename	File path of the source FileMaker Pro file.
username	Source file account user name. Defaults to 'Admin', if not entered, and will be used to sign in.
password	Source file account password. Defaults to blank, if not entered, and will be used to sign in.
‑target_filename	File path of the newly generated target FileMaker Pro file.
‑encryption_key	EAR (encryption at rest) password of the source file.

Note This command requires the Allow exporting privilege.

‑‑copySelfContained

Creates a self-contained copy of an FMP12 file that contains all the tables, layouts, scripts, field definitions, and all of the data with these options:

Options	Description
source_filename	File path of the source FileMaker Pro file.
username	Source file account user name. Defaults to 'Admin', if not entered, and will be used to sign in.
password	Source file account password. Defaults to blank, if not entered, and will be used to sign in.
‑target_filename	File path of the newly generated target FileMaker Pro file.
‑encryption_key	EAR (encryption at rest) password of the source file.

Note This command requires the Allow exporting privilege.

‑‑saveAsXML

Creates an XML copy of an FMP12 file that contains all the tables, layouts, scripts, field definitions, and all of the data with these options:

Options	Description
source_filename	File path of the source FileMaker Pro file.
username	Source file account user name. Defaults to 'Admin', if not entered, and will be used to sign in.
password	Source file account password. Defaults to blank, if not entered, and will be used to sign in.
‑target_filename	File path of the newly generated target FileMaker Pro file.
‑encryption_key	EAR (encryption at rest) password of the source file.

Note This command requires the Allow exporting privilege.

‑‑enableEncryption

Encrypts an FMP12 file with these options:

Options	Description
source_filename	File path of the source FileMaker Pro file.
username	Source file account user name. Defaults to 'Admin', if not entered, and will be used to sign in.
password	Source file account password. Defaults to blank, if not entered, and will be used to sign in.
‑target_filename	File path of the newly generated target FileMaker Pro file.
‑encryption_key	EAR (encryption at rest) password of the source file.
‑sharedID	Shared ID of the files encrypted at the same time. (required)
‑passcode	EAR password of the target file. (required)
‑passcode_hint	EAR password hint of the target file.
‑keep_open_storage	EAR option, if added, will prevent the transfer of open storage container data into secure containers. Default is off.

‑‑removeEncryption

Decrypts an FMP12 file with these options:

Options	Description
source_filename	File path of the source FileMaker Pro file.
username	Source file account user name. Defaults to 'Admin', if not entered, and will be used to sign in.
password	Source file account password. Defaults to blank, if not entered, and will be used to sign in.
‑target_filename	File path of the newly generated target FileMaker Pro file.
‑encryption_key	EAR (encryption at rest) password of the source file.

‑‑removeAdminAccess

Removes Full Access privileges from an FMP12 file with these options:

Options	Description
source_filename	File path of the source FileMaker Pro file.
‑target_filename	File path of the newly generated target FileMaker Pro file.
‑encryption_key	EAR (encryption at rest) password of the source file.

‑‑enableKiosk

Enables Kiosk mode in an FMP12 file with these options:

Options	Description
source_filename	File path of the source FileMaker Pro file.
‑target_filename	File path of the newly generated target FileMaker Pro file.
‑encryption_key	EAR (encryption at rest) password of the source file.

‑‑recover

Recovers an FMP12 file with these options:

Options	Description
source_filename	File path of the source FileMaker Pro file.
‑target_filename	File path of the newly generated target FileMaker Pro file.
‑encryption_key	EAR (encryption at rest) password of the source file.
‑generate	Recovery option (rebuild, datablocks, asis). Only one option is allowed at a time. Default option is rebuild.
‑rebuildIndex	Recovery option (now, later, false). Only one option is allowed at a time. Default option is now (can be turned off).
‑skipSchema	Recovery option. When used, skips rebuilding the schema. Default option is off.
‑skipStructure	Recovery option. When used, skips rebuilding the structure. Default option is off.
‑keepCaches	Recovery option. When used, deletes cached settings. Otherwise, cached settings are kept. Default option is false (delete cached settings).
‑bypass	Recovery option. When used, bypasses startup the script and layout. Requires Full Access privileges. When this option is used, users need to provide a Full Access privileges account ([-username \| -u <username>] [-password \| -p <password>]). Default option is off.

‑‑checkConsistency

Performs consistency check on an FMP12 file with these options:

Options	Description
source_filename	File path of the source FileMaker Pro file.
‑encryption_key	EAR (encryption at rest) password of the source file.

‑‑renameFiles

Renames multiple FMP12 files with these options:

Options	Description
username	Source file account user name. Defaults to 'Admin', if not entered, and will be used to sign in.
password	Source file account password. Defaults to blank, if not entered, and will be used to sign in.
‑target_folder	Target folder path.
‑source_filelist	List of source file paths or folder paths which contain source FileMaker Pro files (<path1> <path2> ...). (required)
‑encryption_key	EAR (encryption at rest) password of the source file.
‑regex	Regex (regular expression) for searching and replacing file names. (required)
‑replace_text	Replace text for the regex replace file names. Default value is an empty string.

These options can be used with any subcommand:

Options	Description
‑f (force replace)	Overwrites an existing output file.
‑v (verbose mode)	Provides details about the upgrade process. Outputs the subcommand and options used, but not a password or passkey.
‑q (quiet mode)	Outputs minimal information.

Notes

If the file specified by ‑target_filename already exists, an error is returned and the operation is terminated unless ‑force is used. If ‑target_filename isn't specified, a suitable path and filename will be generated.
The developer tool returns an integer to the shell that calls it: zero (0) when it is successful, a non-zero number when there is an error. For the meaning of an error, see the error message that the tool outputs.

Was this topic helpful? Send feedback.