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
-t

File path of the newly generated target FileMaker Pro file.

-encryption_key
-e

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
-t

File path of the newly generated target FileMaker Pro file.

-encryption_key
-e

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
-t

File path of the newly generated target FileMaker Pro file.

-encryption_key
-e

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
-t

File path of the newly generated target FileMaker Pro file.

-encryption_key
-e

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
-t

File path of the newly generated target FileMaker Pro file.

-encryption_key
-e

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
-t

File path of the newly generated target FileMaker Pro file.

-encryption_key
-e

EAR (encryption at rest) password of the source file.

-sharedID
-s

Shared ID of the files encrypted at the same time. (required)

-passcode
-p

EAR password of the target file. (required)

-passcode_hint
-h

EAR password hint of the target file.

-keep_open_storage
-o

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
-t

File path of the newly generated target FileMaker Pro file.

-encryption_key
-e

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
-t

File path of the newly generated target FileMaker Pro file.

-encryption_key
-e

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
-t

File path of the newly generated target FileMaker Pro file.

-encryption_key
-e

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
-t

File path of the newly generated target FileMaker Pro file.

-encryption_key
-e

EAR (encryption at rest) password of the source file.

-generate
-g

Recovery option (rebuild, datablocks, asis). Only one option is allowed at a time. Default option is rebuild.

-rebuildIndex
-i

Recovery option (now, later, false). Only one option is allowed at a time. Default option is now (can be turned off).

-skipSchema
-r

Recovery option. When used, skips rebuilding the schema. Default option is off.

-skipStructure
-l

Recovery option. When used, skips rebuilding the structure. Default option is off.

-keepCaches
-k

Recovery option. When used, deletes cached settings. Otherwise, cached settings are kept. Default option is false (delete cached settings).

-bypass
-b

Recovery option. When used, bypasses startup the script and layout. Requires Full Access privilege set. When this option is used, users need to provide an account with the Full Access privilege set ([-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
-e

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
-t

Target folder path.

-source_filelist
-sl

List of source file paths or folder paths which contain source FileMaker Pro files (<path1> <path2> ...). (Required)

-encryption_key
-e

EAR (encryption at rest) password of the source file.

-regex
-rg

Regex (regular expression) for searching and replacing file names. (Required)

-replace_text
-rt

Replace text for the regex replace file names. Default value is an empty string.

--querySize

Queries an FMP12 file for the total size of all record data in a target table, all record data in a target field, or a target field's word and value indexes 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.

-encryption_key
-e

EAR (encryption at rest) password of the source file.

-target_tablename
-tt

Target table name.

-target_fieldname
-tf

Target field name.

-query_index
-qi

Returns field index size instead of field data size. Must also specify -target_tablename and -target_fieldname. For all field index sizes, use the --sortBySize subcommand.

-exclude_container
-ec

Excludes the size of embedded container fields from total size of all record data in a table. Works only when querying for table size, not for a specific field size or field index size.

-size_unit
-su

Unit for returned sizes. Values can be "bytes", "kb", "mb", or "gb" (the default is "bytes").

--sortBySize

Returns a list of the record data sizes or index sizes (largest to smallest) for each field of a target table in 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.

-encryption_key
-e

EAR (encryption at rest) password of the source file.

-target_tablename
-tt

Target table name.

-query_index
-qi

Returns field index size instead of field data size. Must also specify -target_tablename. For single field index sizes, use the --querySize subcommand.

-quantity
-qu

Number of fields or field indexes to return sizes for. If not specified, returns all.

-exclude_container
-ec

Excludes embedded container fields from the list.

-size_unit
-su

Unit for returned sizes. Values can be "bytes", "kb", "mb", or "gb" (the default is "bytes").

-csv_format
-cf

Outputs results in comma-separated value (CSV) format, which can be redirected to a file.

--uploadDatabases

Uploads one or more FMP12 files to a FileMaker Server host with these options:

Options Description

<host_name>

Host's fully-qualified domain name or IP address. For example:

  • myhost.example.com

  • 127.0.0.1

<host_username>

Host's administrator user name.

<host_password>

Host's administrator password.

-database_pathlist
-dl

List of paths for database files or folders containing database files (separated by a space). If the path is for a folder, only the .fmp12 files in the folder are uploaded. If any of the database files are encrypted, they must all be encrypted with the same EAR password specified by -encryption_key. Otherwise, you must upload them in separate commands, each with the correct EAR password.

-encryption_key
-e

EAR (encryption at rest) password of the source file.

-target_folder
-tf

Database folder on the host to upload to. The path is the same as shown in the Upload to Host dialog in FileMaker Pro. If not specified, the default is Databases/. The secure database folder is Secure/ (only encrypted databases can be uploaded to this folder). The additional database folder isn't supported.

For existing subfolders in the default database folder, add the subfolder name after the folder name—for example, Databases/Sample/. This subcommand doesn't create subfolders.

Note  Folder and subfolder names must be followed by a slash (/).

-without_remote_container
-worc

Uploads only FMP12 database files, without any externally stored container data. If not specified, uploads external container data as well.

-automatically_open_db_off
-aodo

Disables automatically opening databases on the host after upload. If not specified, databases are automatically opened on the host after upload (if encrypted, they are opened only if they are uploaded to the secure database folder).

-ignore_certificate
-ic

Ignores SSL certificate verification. If not specified, the host's SSL certificate is verified before uploading. If verification fails, an error is returned and the database is not uploaded.

Before uploading, this subcommand performs the same security and consistency checks as FileMaker Pro does before uploading. (See Uploading database files using FileMaker Pro in FileMaker Server Help.) The -force option isn't supported to overwrite a database on the host; you must close and remove the hosted database before uploading another database with the same name.

These options can be used with any subcommand:

Options Description

-force
-f

Force replace. Overwrites an existing output file.

-verbose
-v

Verbose mode. Provides details about the upgrade process. Outputs the subcommand and options used, but not a password or passkey.

-quiet
-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.