Claris FileMaker Developer Tool Guide

https://help.claris.com/en/developer-tool-guide/content/
Admin
The Claris FileMaker Developer Tool (FMDeveloperTool) is a command-line utility for FileMaker Server...
Tokens:4,817
Snippets:65
Trust Score:10
Update:1 month ago
Show doc for...
Tokens:
Raw
### Enable Kiosk Mode

Source: https://help.claris.com/en/developer-tool-guide/content/examples.html

Configures a database file to run in Kiosk mode and saves it to a target file.

```bash
FMDeveloperTool --enableKiosk SampleDB.fmp12 -target_filename "SampleDB kiosk.fmp12" -encryption_key abc
```

--------------------------------

### Upload Databases to Host

Source: https://help.claris.com/en/developer-tool-guide/content/examples.html

Deploys encrypted database files to a FileMaker Server host.

```bash
FMDeveloperTool --uploadDatabases myhost.example.com admin admin -database_pathlist SampleDB.fmp12 -encryption_key abc -target_folder Secure/
```

```bash
FMDeveloperTool --uploadDatabases myhost.example.com admin admin -database_pathlist MyApps ~/Documents/SampleDB4.fmp12 -encryption_key abc -target_folder Secure/ -without_remote_container -automatically_open_db_off
```

--------------------------------

### Enable Kiosk mode

Source: https://help.claris.com/en/developer-tool-guide/content/examples.html

Configures a database file to run in Kiosk mode.

```APIDOC
## FMDeveloperTool --enableKiosk

### Description
Enables Kiosk mode in the source file and saves the output to a target file.

### Command
FMDeveloperTool --enableKiosk [source_file] -target_filename [target_file] -encryption_key [key]
```

--------------------------------

### Copy and Compress a FileMaker Database

Source: https://help.claris.com/en/developer-tool-guide/content/examples.html

Copies the source file and applies compression to the target file.

```bash
FMDeveloperTool --copyCompress SampleDB.fmp12 admin admin -target_filename "SampleDB copied compressed.fmp12" -encryption_key abc
```

--------------------------------

### FMDeveloperTool --uploadDatabases

Source: https://help.claris.com/en/developer-tool-guide/content/examples.html

Uploads encrypted database files to a FileMaker Server host.

```APIDOC
## FMDeveloperTool --uploadDatabases

### Description
Uploads encrypted database files to the secure database folder on a FileMaker Server host. Options allow for excluding remote container data and disabling automatic database opening.

### Usage
FMDeveloperTool --uploadDatabases [host] [username] [password] -database_pathlist [paths] -encryption_key [key] -target_folder [folder] [-without_remote_container] [-automatically_open_db_off]
```

--------------------------------

### Save Database as XML

Source: https://help.claris.com/en/developer-tool-guide/content/examples.html

Exports the file structure as an XML file, including optional plug-in folder paths and details.

```bash
FMDeveloperTool --saveAsXML SampleDB.fmp12 admin admin -target_filename "SampleDB.xml" -encryption_key abc -include_details -plugin_folder "PlugInPath"
```

--------------------------------

### Copy and compress

Source: https://help.claris.com/en/developer-tool-guide/content/examples.html

Copies and compresses a source file to a target file.

```APIDOC
## Copy and compress

### Description
Copies the source file to the target file and compresses the target file.

### Command
`FMDeveloperTool --copyCompress [source_file] [account_name] [account_password] -target_filename [target_filename] -encryption_key [encryption_key]`

### Example
`FMDeveloperTool --copyCompress SampleDB.fmp12 admin admin -target_filename "SampleDB copied compressed.fmp12" -encryption_key abc`
```

--------------------------------

### Copy

Source: https://help.claris.com/en/developer-tool-guide/content/examples.html

Copies a source file to a target file.

```APIDOC
## Copy

### Description
Copies the source file to the target file.

### Command
`FMDeveloperTool --copy [source_file] [account_name] [account_password] -target_filename [target_filename] -encryption_key [encryption_key]`

### Example
`FMDeveloperTool --copy SampleDB.fmp12 admin admin -target_filename "SampleDB copied.fmp12" -encryption_key abc`
```

--------------------------------

### Save as XML

Source: https://help.claris.com/en/developer-tool-guide/content/examples.html

Saves the source file as an XML file.

```APIDOC
## Save as XML

### Description
Saves the source file as XML to the target file.

### Command
`FMDeveloperTool --saveAsXML [source_file] [account_name] [account_password] -target_filename [target_filename] -encryption_key [encryption_key] -include_details -plugin_folder [path]`

### Example
`FMDeveloperTool --saveAsXML SampleDB.fmp12 admin admin -target_filename "SampleDB.xml" -encryption_key abc -include_details -plugin_folder "PlugInPath"`
```

--------------------------------

### Copy as self-contained

Source: https://help.claris.com/en/developer-tool-guide/content/examples.html

Copies a source file and embeds all container data.

```APIDOC
## Copy as self-contained

### Description
Copies the source file to the target file and embeds all container data in the target file.

### Command
`FMDeveloperTool --copySelfContained [source_file] [account_name] [account_password] -target_filename [target_filename] -encryption_key [encryption_key]`

### Example
`FMDeveloperTool --copySelfContained SampleDB.fmp12 admin admin -target_filename "SampleDB copied self-contained.fmp12" -encryption_key abc`
```

--------------------------------

### Copy as Self-Contained

Source: https://help.claris.com/en/developer-tool-guide/content/examples.html

Copies the source file and embeds all container data directly into the target file.

```bash
FMDeveloperTool --copySelfContained SampleDB.fmp12 admin admin -target_filename "SampleDB copied self-contained.fmp12" -encryption_key abc
```

--------------------------------

### Copy a FileMaker Database

Source: https://help.claris.com/en/developer-tool-guide/content/examples.html

Copies a source file to a new target filename using specified credentials and encryption key.

```bash
FMDeveloperTool --copy SampleDB.fmp12 admin admin -target_filename "SampleDB copied.fmp12" -encryption_key abc
```

--------------------------------

### Clone

Source: https://help.claris.com/en/developer-tool-guide/content/examples.html

Clones a source file to a target file.

```APIDOC
## Clone

### Description
Clones the source file to the target file.

### Command
`FMDeveloperTool --clone [source_file] [account_name] [account_password] -target_filename [target_filename] -encryption_key [encryption_key]`

### Example
`FMDeveloperTool --clone SampleDB.fmp12 admin admin -target_filename "SampleDB cloned.fmp12" -encryption_key abc`
```

--------------------------------

### Clone a FileMaker Database

Source: https://help.claris.com/en/developer-tool-guide/content/examples.html

Creates a clone of the source file with a new target filename.

```bash
FMDeveloperTool --clone SampleDB.fmp12 admin admin -target_filename "SampleDB cloned.fmp12" -encryption_key abc
```

--------------------------------

### Set Windows command window code page to UTF-8

Source: https://help.claris.com/en/developer-tool-guide/content/before-you-begin.html

Use this command to ensure UTF-8 characters display correctly in the developer tool output on Windows.

```shell
> chcp 65001  
Active code page: 65001
```

--------------------------------

### Query for table, field, or index sizes

Source: https://help.claris.com/en/developer-tool-guide/content/examples.html

Returns the size of tables, fields, or indexes within a database.

```APIDOC
## FMDeveloperTool --querySize

### Description
Queries the size of record data for tables, fields, or indexes.

### Usage
FMDeveloperTool --querySize [file_path] [account] [password] -encryption_key [key] -target_tablename [table] [-target_fieldname [field]] [-size_unit [unit]] [-query_index]

### Parameters
- **file_path** (string) - Required - The path to the .fmp12 file.
- **account** (string) - Required - Database account name.
- **password** (string) - Required - Database password.
- **-encryption_key** (string) - Optional - The encryption key.
- **-target_tablename** (string) - Required - The name of the table to query.
- **-target_fieldname** (string) - Optional - The name of the field to query.
- **-size_unit** (string) - Optional - The unit of measurement (e.g., mb).
- **-query_index** (flag) - Optional - If present, queries the index size instead of record data.
```

--------------------------------

### Recover a Database File

Source: https://help.claris.com/en/developer-tool-guide/content/examples.html

Performs a recovery operation on a database file, including index rebuilding and bypassing startup scripts.

```bash
FMDeveloperTool --recover SampleDB.fmp12 -target_filename "SampleDB recovered.fmp12" -encryption_key abc -generate rebuild -rebuildIndex now -bypass -username admin -password admin
```

--------------------------------

### Recover

Source: https://help.claris.com/en/developer-tool-guide/content/examples.html

Recovers and repairs a corrupted database file.

```APIDOC
## FMDeveloperTool --recover

### Description
Recovers the source file by rebuilding the structure and indexes, with options to bypass startup scripts.

### Command
FMDeveloperTool --recover [source_file] -target_filename [target_file] -encryption_key [key] -generate [rebuild_option] -rebuildIndex [timing] -bypass -username [admin_user] -password [admin_password]
```

--------------------------------

### Change account password with FMDeveloperTool

Source: https://help.claris.com/en/developer-tool-guide/content/examples.html

Updates the password for a specific user account in a FileMaker database. Requires administrative credentials for the target file.

```bash
FMDeveloperTool --changeAccountPassword SampleDB.fmp12 admin admin -target_useraccount admin2 -new_password admin2pwd
```

--------------------------------

### Query Table Size

Source: https://help.claris.com/en/developer-tool-guide/content/examples.html

Retrieves the total record data size for a specific table in megabytes.

```bash
FMDeveloperTool --querySize SampleDB.fmp12 admin admin -encryption_key abc -target_tablename "Product Details" -size_unit mb
```

--------------------------------

### Encrypt a FileMaker Database

Source: https://help.claris.com/en/developer-tool-guide/content/examples.html

Encrypts a source database file and saves it to a target location with specified security parameters.

```bash
FMDeveloperTool --enableEncryption SampleDB.fmp12 admin admin -target_filename "SampleDB encrypted.fmp12" -encryption_key abc -sharedID 123 -passcode admin -passcode_hint hint -keep_open_storage
```

--------------------------------

### Query Field Index Size

Source: https://help.claris.com/en/developer-tool-guide/content/examples.html

Retrieves the value and word index sizes for a specific field.

```bash
FMDeveloperTool --querySize SampleDB.fmp12 admin admin -encryption_key abc -target_tablename "Product Details" -target_fieldname Name -query_index
```

--------------------------------

### Check File Consistency

Source: https://help.claris.com/en/developer-tool-guide/content/examples.html

Verifies the integrity of a specified FileMaker database file using an encryption key.

```bash
FMDeveloperTool --checkConsistency SampleDB.fmp12 -encryption_key abc
```

--------------------------------

### FMDeveloperTool --sortBySize

Source: https://help.claris.com/en/developer-tool-guide/content/examples.html

Identifies the fields containing the most record data within a specific table.

```APIDOC
## FMDeveloperTool --sortBySize

### Description
Returns the top fields that contain the most record data in the target table of the source file.

### Usage
FMDeveloperTool --sortBySize [filename] [username] [password] -encryption_key [key] -target_tablename [tablename] -quantity [number]
```

--------------------------------

### Remove Full Access Privileges

Source: https://help.claris.com/en/developer-tool-guide/content/examples.html

Strips Full Access privileges from a database file and saves the modified version.

```bash
FMDeveloperTool --removeAdminAccess SampleDB.fmp12 admin admin -target_filename "SampleDB admin removed.fmp12" -encryption_key abc
```

--------------------------------

### Rename Files with Regex

Source: https://help.claris.com/en/developer-tool-guide/content/examples.html

Renames files within a source list based on a regular expression match and moves them to a target directory.

```bash
FMDeveloperTool --renameFiles TargetDBFolder admin admin -encryption_key abc -source_filelist SampleDB1 abc 123.fmp12 SampleDB2 abcX123.fmp12 SampleDB3 abc.123.fmp12 -regex "abc.123" -replace_text "abc-123"
```

--------------------------------

### Analyze Field Data Size

Source: https://help.claris.com/en/developer-tool-guide/content/examples.html

Identifies the top fields by data size within a specific table.

```bash
FMDeveloperTool --sortBySize SampleDB.fmp12 admin admin -encryption_key abc -target_tablename "Product Details" -quantity 5
```

--------------------------------

### Encrypt

Source: https://help.claris.com/en/developer-tool-guide/content/examples.html

Encrypts a FileMaker database file with specified security parameters.

```APIDOC
## FMDeveloperTool --enableEncryption

### Description
Encrypts the source file and saves it to a target file with specified encryption keys, shared IDs, and passcodes.

### Command
FMDeveloperTool --enableEncryption [source_file] [account_name] [password] -target_filename [target_file] -encryption_key [key] -sharedID [id] -passcode [passcode] -passcode_hint [hint] -keep_open_storage
```

--------------------------------

### Check consistency

Source: https://help.claris.com/en/developer-tool-guide/content/examples.html

Checks the consistency of a specified FileMaker database file.

```APIDOC
## FMDeveloperTool --checkConsistency

### Description
Checks the consistency of the specified source file.

### Usage
FMDeveloperTool --checkConsistency [file_path] -encryption_key [key]

### Parameters
- **file_path** (string) - Required - The path to the .fmp12 file.
- **-encryption_key** (string) - Optional - The encryption key for the database.
```

--------------------------------

### Query Field Size

Source: https://help.claris.com/en/developer-tool-guide/content/examples.html

Retrieves the total record data size for a specific field within a table in megabytes.

```bash
FMDeveloperTool --querySize SampleDB.fmp12 admin admin -encryption_key abc -target_tablename "Product Details" -target_fieldname Photo -size_unit mb
```

--------------------------------

### Rename files

Source: https://help.claris.com/en/developer-tool-guide/content/examples.html

Renames files in a source list based on a regular expression and moves them to a target folder.

```APIDOC
## FMDeveloperTool --renameFiles

### Description
Renames files in the source file list using a regex pattern and moves them to the target folder.

### Usage
FMDeveloperTool --renameFiles [target_folder] [account] [password] -encryption_key [key] -source_filelist [files] -regex [pattern] -replace_text [text]

### Parameters
- **target_folder** (string) - Required - The destination directory.
- **account** (string) - Required - Database account name.
- **password** (string) - Required - Database password.
- **-encryption_key** (string) - Optional - The encryption key.
- **-source_filelist** (list) - Required - List of files to process.
- **-regex** (string) - Required - Regular expression to match file names.
- **-replace_text** (string) - Required - Text to replace the matched pattern.
```

--------------------------------

### FMDeveloperTool --resetFileUUID

Source: https://help.claris.com/en/developer-tool-guide/content/examples.html

Regenerates the unique ID (UUID) of a specified database file.

```APIDOC
## FMDeveloperTool --resetFileUUID

### Description
Regenerates the UUID of the specified source file.

### Usage
FMDeveloperTool --resetFileUUID [filename] [username] [password] -encryption_key [key]
```

--------------------------------

### FMDeveloperTool --changeAccountPassword

Source: https://help.claris.com/en/developer-tool-guide/content/examples.html

Changes the password for a specified user account within a FileMaker database file.

```APIDOC
## FMDeveloperTool --changeAccountPassword

### Description
Changes the password for a specific user account in a FileMaker database file.

### Command
`FMDeveloperTool --changeAccountPassword <file> <admin_user> <admin_password> -target_useraccount <target_user> -new_password <new_password>`

### Parameters
- **file** (string) - Required - The path to the .fmp12 database file.
- **admin_user** (string) - Required - The administrator username.
- **admin_password** (string) - Required - The administrator password.
- **-target_useraccount** (string) - Required - The account name to modify.
- **-new_password** (string) - Required - The new password to set for the target account.

### Example
`FMDeveloperTool --changeAccountPassword SampleDB.fmp12 admin admin -target_useraccount admin2 -new_password admin2pwd`
```

--------------------------------

### Remove Full Access privileges

Source: https://help.claris.com/en/developer-tool-guide/content/examples.html

Removes administrative access privileges from a database file.

```APIDOC
## FMDeveloperTool --removeAdminAccess

### Description
Removes Full Access privileges from the source file and saves the modified file to a target destination.

### Command
FMDeveloperTool --removeAdminAccess [source_file] [account_name] [password] -target_filename [target_file] -encryption_key [key]
```

--------------------------------

### Decrypt a FileMaker Database

Source: https://help.claris.com/en/developer-tool-guide/content/examples.html

Removes encryption from a source database file and saves the result to a new file.

```bash
FMDeveloperTool --removeEncryption SampleDB.fmp12 admin admin -target_filename "SampleDB decrypted.fmp12" -encryption_key abc
```

--------------------------------

### Decrypt

Source: https://help.claris.com/en/developer-tool-guide/content/examples.html

Removes encryption from a FileMaker database file.

```APIDOC
## FMDeveloperTool --removeEncryption

### Description
Decrypts the source file and saves the result to a target file.

### Command
FMDeveloperTool --removeEncryption [source_file] [account_name] [password] -target_filename [target_file] -encryption_key [key]
```

--------------------------------

### Regenerate File UUID

Source: https://help.claris.com/en/developer-tool-guide/content/examples.html

Resets the unique identifier for a specified FileMaker database file.

```bash
FMDeveloperTool --resetFileUUID SampleDB.fmp12 admin admin -encryption_key abc
```
Tokens:
Raw