Claris FileMaker Pro

https://help.claris.com/en/pro-help/content/
Admin
Claris FileMaker Pro is a powerful tool for creating custom apps, managing data, automating tasks...
Tokens:712,042
Snippets:6,665
Trust Score:10
Update:1 week ago
Show doc for...
Tokens:
Raw
### Install Menu Set Example: Conditional Menu Set Installation

Source: https://help.claris.com/en/pro-help/content/install-menu-set.html

Example script that goes to the Invoice Details layout and installs the Invoices Menu Set if the Print Invoices Menu Set is currently installed. Uses the Get(CustomMenuSetName) function to check the current menu set.

```FileMaker
Go to Layout ["Invoice Details"]  
If [Get ( CustomMenuSetName ) = "Print Invoices Menu Set"]  
    Install Menu Set ["Invoices Menu Set" ; Use as file default: Off]  
End If
```

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

### Example 1: Count installed plug-ins

Source: https://help.claris.com/en/pro-help/content/get-installedfmpluginsasjson.html

Returns the number of installed plug-ins by counting the keys in the plugins array of the JSON object returned by Get(InstalledFMPluginsAsJSON).

```plaintext
ValueCount ( JSONListKeys ( Get ( InstalledFMPluginsAsJSON ) ; "plugins" ) )
```

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

### Example returned JSON object

Source: https://help.claris.com/en/pro-help/content/get-installedfmpluginsasjson.html

Example of the JSON object returned by Get(InstalledFMPluginsAsJSON) with two installed plug-ins in the plugins array. The environment object is returned even if no plug-ins are installed. The plugins array is null if no plug-ins are installed.

```json
{  
    "APIVers": 2,  
    "environment" :  
    {  
        "architecture" : "arm64",  
        "platform" : 1,  
        "version" : "11.3"  
    },  
    "plugins":  
    [  
        {  
            "name": "MyPlugin1",  
            "id": "XM32",  
            "version": "1.0",  
            "state": "Enabled",  
            "filepath": "filemac:/HD/Users/user1/Library/Application Support/FileMaker/Extensions/MyPlugin1.fmplugin/",  
            "description": "This is a sample FileMaker plug-in."  
        },  
        {  
            "name": "MyPlugin2",  
            "id": "BO3B",  
            "version": "1.1.6x3422",  
            "state": "Disabled",  
            "filepath": "filemac:/HD/Users/user1/Library/Application Support/FileMaker/FileMaker Pro/26.0/Extensions/MyPlugin2.fmplugin/",  
            "description": "This is another FileMaker plug-in."  
        }  
    ]  
}
```

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

### Print Setup Example: Navigate, Sort, Set Print Options, and Print

Source: https://help.claris.com/en/pro-help/content/print-setup.html

Example script that goes to the Print Invoices layout, sorts records, changes print settings using Print Setup, and prints. The Print Setup step uses Restore and With dialog: Off, while Print uses With dialog: On.

```FileMaker
Go to Layout ["Print Invoices"]  
Sort Records [Restore; With dialog: Off]  
Print Setup [Restore; With dialog: Off]  
Print [With dialog: On]
```

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

### Example 1: Multiple file paths for local file access (filewin/filemac, Get (DocumentsPath))

Source: https://help.claris.com/en/pro-help/content/creating-file-paths.html

Example 1: provides two separate file paths for Windows and macOS to access a local file. The alternative uses Get (DocumentsPath) to create a platform-independent path when the Hosted folder is in both systems' Documents folder. File paths are searched in order, and the first successful file is opened.

```text
filewin:/C:/ExcelFiles/Hosted/test.xlsx
filemac:/MacintoshHD/ExcelFiles/Hosted/test.xlsx
```

```text
"file:" & Get ( DocumentsPath ) & "Hosted/test.xlsx"
```

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

### Example 1: Show Custom Dialog and Set Multi-User On

Source: https://help.claris.com/en/pro-help/content/set-multi-user.html

Guarantees that a database is hosted upon launch. Started by the OnFirstWindowOpen script trigger.

```FileMaker
Show Custom Dialog ["Make this file available on the network?"]  
If [Get ( LastMessageChoice ) = 1]  
    Set Multi-User [On]  
End If
```

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

### Install Video Plug-In with Confirmation Dialog

Source: https://help.claris.com/en/pro-help/content/install-plug-in-file.html

Shows a confirmation dialog and installs the Video plug-in from the Plugins::Video container field if the user confirms. Uses the Get(LastMessageChoice) function to check the dialog result.

```FileMaker
Show Custom Dialog ["Do you want to install the latest version of the Video Plug-In?"]  
If [Get ( LastMessageChoice ) = 1]  
    Install Plug-In File[Plugins::Video]  
End If
```

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

### Measure script duration with Get(CurrentTimeUTCMicroseconds)

Source: https://help.claris.com/en/pro-help/content/get-currenttimeutcmicroseconds.html

Example 1: A script that calculates the time to find and sort records. It stores the start and end times in variables and displays the difference in a custom dialog.

```plaintext
Set Variable [$START ; Get ( CurrentTimeUTCMicroseconds )]  
Go to Layout ["Invoices"]  
Perform Find [Restore]  
Sort Records [Restore; With dialog: Off]  
Set Variable [$END ; Get ( CurrentTimeUTCMicroseconds )]  
Show Custom Dialog ["Script Duration" ; ( $END - $START ) & " microseconds"]
```

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

### Calculate script duration using Get(CurrentTimeUTCMilliseconds)

Source: https://help.claris.com/en/pro-help/content/get-currenttimeutcmilliseconds.html

Example 1: Calculates the time taken to find and sort records. Stores start and end times in variables, then displays the difference in seconds in a custom dialog.

```filemaker
Set Variable [$START ; Get ( CurrentTimeUTCMilliseconds )]  
Go to Layout ["Invoices"]  
Perform Find [Restore]  
Sort Records [Restore; With dialog: Off]  
Set Variable [$END ; Get ( CurrentTimeUTCMilliseconds )]  
Show Custom Dialog ["Script Duration" ; ( $END - $START ) / 1000 & " seconds"]
```

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

### Example 2: Multiple file paths with fallbacks for hosted database (fmnet, file)

Source: https://help.claris.com/en/pro-help/content/creating-file-paths.html

Example 2: for scripted record import, lists a primary hosted file and two fallback files (one on another server, one local) to try in order if the host is unavailable. FileMaker clients search for the next file if a previous one is unavailable.

```text
fmnet:/host1.domain.com/Databases/test.fmp12
fmnet:/host2.domain.com/Databases/test.fmp12
file:../Databases/test.fmp12
```

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

### Show Custom Dialog with Get(RegionMonitorEvents) example

Source: https://help.claris.com/en/pro-help/content/get-regionmonitorevents.html

Example script step that displays a custom dialog with the events returned by Get(RegionMonitorEvents). The dialog shows the region name and timestamps of entry/exit events.

```filemaker
Show Custom Dialog ["New device detected" ; Get(RegionMonitorEvents)]
```

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

### ListPersistentDataIDs example call and output

Source: https://help.claris.com/en/pro-help/content/listpersistentdataids.html

Example 1: Calls ListPersistentDataIDs with the name "com.example.addon.script" and shows the returned list of instance IDs. The third line is blank because that entry has an empty instance ID.

```plaintext
ListPersistentDataIDs ( "com.example.addon.script" )
```

```plaintext
38EA3124-9CFD-4490-A634-A0A72A613145  
E53DE16C-282E-44B0-BDB8-D59B15419D1B  
  
B2F4C8D1-5A3E-4F9B-8C7D-1E6A9B4D2F5C
```

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

### Example returned JSON object from GetAddonInfo

Source: https://help.claris.com/en/pro-help/content/getaddoninfo.html

Example JSON object returned by GetAddonInfo for an add-on installed from the packaged add-on 'People' and renamed 'Renamed People'. Includes APIVers, Installed, and Package elements.

```JSON
{  
    "APIVers" : 2,  
    "Installed" :  
    {  
        "Name" : "Renamed People",  
        "UUID" : "B79DDD6D-DDF2-4370-A3C9-F9DEF2C52992",  
        "UsesLayoutPayload" : 1,  
        "UsesRelationship" : 1  
    },  
    "Package" :  
    {  
        "Name" : "People",  
        "UUID" : "3CB70E8B-B45E-4EF1-B2DD-8CA7DDB3CDC1"  
    }  
}
```

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

### Startup Script: Go to Layout Based on Privilege Set

Source: https://help.claris.com/en/pro-help/content/script-examples.html

Goes to the Administration layout if the account has Full Access privilege set, otherwise goes to Data Entry layout. Uses Get ( AccountPrivilegeSetName ).

```FileMaker
If [Get ( AccountPrivilegeSetName ) = "[Full Access]"]  
    Go to Layout ["Administration"]  
Else  
    Go to Layout ["Data Entry"]  
End If
```

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

### Get(InstalledFMPluginsAsJSON)

Source: https://help.claris.com/en/pro-help/content/get-functions.html

Returns a JSON object with the attributes of installed plug-ins.

```APIDOC
## Get(InstalledFMPluginsAsJSON)

### Description
Returns a JSON object with the attributes of installed plug-ins.

### Function
Get(InstalledFMPluginsAsJSON)

### Returns
JSON object with plug-in attributes.
```

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

### Get(ActiveSelectionStart)

Source: https://help.claris.com/en/pro-help/content/get-functions.html

Returns a number representing the starting character of the selected text.

```APIDOC
## Get(ActiveSelectionStart)

### Description
Returns a number representing the starting character of the selected text.

### Function
Get(ActiveSelectionStart)

### Returns
Number
```

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

### Move/Resize Window Example

Source: https://help.claris.com/en/pro-help/content/move-resize-window.html

Goes to the Customer Info layout, positions the window at the top-left corner, and resizes it to 400x600 points. This example uses the Current Window option.

```FileMaker
Go to Layout [ "Customer Info" ]  
Move/Resize Window [ Current Window ; Height: 400 ; Width: 600 ; Top: 0 ; Left: 0 ]
```

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

### Get(InstalledFMPlugins)

Source: https://help.claris.com/en/pro-help/content/get-installedfmplugins.html

Returns the name, version number, and enabled state of installed plug-ins. Useful for determining whether an installed plug-in is newer or older than a plug-in required by a file.

```APIDOC
## Get(InstalledFMPlugins)

### Description
Returns the name, version number, and enabled state of installed plug-ins. Useful for determining whether an installed plug-in is newer or older than a plug-in required by a file.

### Format
```
Get ( InstalledFMPlugins )
```

### Parameters
None

### Data type returned
text

### Originated in version
12.0

### Description
This function is useful for determining whether an installed plug-in is newer or older than a plug-in required by a file. The version number is returned if it is available.
If multiple plug-ins are installed, Get(InstalledFMPlugins) returns values for each plug-in on separate lines, separated by carriage returns.
Get(InstalledFMPlugins) returns plug-in version information only when plug-in developers have entered version information in the resource file (Windows) or the info.plist file (macOS).
macOS: Plug-ins are stored as packages.
The enabled state is returned as follows:
- **Enabled** – The plug-in is enabled in the FileMaker Pro settings and can be loaded.
- **Disabled** – The plug-in is disabled in the FileMaker Pro settings and cannot be loaded.
- **Ignored** – The plug-in failed to load, which could be due to software incompatibility.

### Example
When:
- MyPlugin1 is installed and is enabled in the Plug-ins tab in the Settings dialog.
- MyPlugin2 is installed and is disabled in the Plug-ins tab in the Settings dialog.
- MyPlugin3 could not be loaded.

Get(InstalledFMPlugins) returns:
```
MyPlugin1;1.0;Enabled
MyPlugin2;1.1;Disabled
MyPlugin3; ;Ignored
```
```

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

### New Window script step example

Source: https://help.claris.com/en/pro-help/content/new-window.html

Creates a new document window named 'Customer List' using the 'Customer List' layout, positioned 100 points from the top and 100 points from the left, with a height of 500 points and a width of 700 points. The window has close, minimize, and maximize buttons enabled.

```plaintext
New Window [Document; Name: 
```

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

### Sample output for Products layout

Source: https://help.claris.com/en/pro-help/content/getfieldsonlayout.html

Possible output stored in $$result for the Products layout, showing all fields and find-accessible fields.

```text
All fields on the current layout:  
CreationDate  
Photo  
Price  
ProductID  
ProductName  
Status  

Of these, the fields accessible to a find are:  
Products::CreationDate  
Products::Price  
Products::ProductID  
Products::ProductName  
Products::Status
```

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

### Get(InstalledFMPlugins)

Source: https://help.claris.com/en/pro-help/content/get-functions.html

Returns the name, version number, and enabled state of installed plug-ins.

```APIDOC
## Get(InstalledFMPlugins)

### Description
Returns the name, version number, and enabled state of installed plug-ins.

### Function
Get(InstalledFMPlugins)

### Returns
Name, version, and enabled state of installed plug-ins.
```

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

### Example: Check for Apple silicon

Source: https://help.claris.com/en/pro-help/content/get-applicationarchitecture.html

Returns "Apple silicon" if evaluated on a Mac with Apple silicon. Uses Get(SystemPlatform) and Get(ApplicationArchitecture) to check the platform and architecture.

```plaintext
If (  
    Get ( SystemPlatform ) = 1 and Get ( ApplicationArchitecture ) = "arm64" ;  
    "Apple silicon"
)
```

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

### Startup Script: Go to Layout Based on Device

Source: https://help.claris.com/en/pro-help/content/script-examples.html

Checks which version of FileMaker Pro or FileMaker Go opened the database and goes to the appropriate Customers layout. Uses Get ( Device ).

```FileMaker
If [Get ( Device ) = 3]  
    Go to Layout ["Customers iPad"]  
Else If [Get ( Device ) = 4]  
    Go to Layout ["Customers iPhone"]  
Else  
    Go to Layout ["Customers"]  
End If
```

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

### Get(SystemStorageAvailable)

Source: https://help.claris.com/en/pro-help/content/get-functions.html

Returns the available storage, in bytes, on the system drive where the FileMaker software is installed.

```APIDOC
## Get(SystemStorageAvailable)

### Description
Returns the available storage, in bytes, on the system drive where the FileMaker software is installed.

### Function
Get(SystemStorageAvailable)

### Parameters
None

### Returns
- **Number** - Available storage in bytes.
```

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

### Example: Print invoices and enter Browse mode

Source: https://help.claris.com/en/pro-help/content/enter-browse-mode.html

This script goes to the 'Print Invoices' layout, enters Preview mode, prints without a dialog, and then enters Browse mode with pause off. It demonstrates a typical print workflow using the Enter Browse Mode step.

```FileMaker
Go to Layout ["Print Invoices"]  
Enter Preview Mode [Pause: Off]  
Print [With dialog: Off]  
Enter Browse Mode [Pause: Off]
```

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

### Get(SystemStorageAvailable)

Source: https://help.claris.com/en/pro-help/content/get-systemstorageavailable.html

Returns the available storage, in bytes, on the system drive where the FileMaker software is installed.

```APIDOC
## Get(SystemStorageAvailable)

### Description
Returns the available storage, in bytes, on the system drive where the FileMaker software is installed.

### Format
```
Get ( SystemStorageAvailable )
```

### Parameters
None

### Data type returned
number

### Originated in version
21.1.1

### Example
Returns 417048244224 on a system with 417,048,244,224 bytes of available storage.

```

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

### Install Plug-In Based on Platform and Architecture

Source: https://help.claris.com/en/pro-help/content/install-plug-in-file.html

Determines the operating system and hardware architecture using Get(InstalledFMPluginsAsJSON) and installs the appropriate plug-in from the Plugins container fields. Handles macOS (Apple silicon and Intel), Windows, and Linux, with fallback messaging for unsupported platforms.

```FileMaker
Set Variable [ $plugin_json ; Value: Get ( InstalledFMPluginsAsJSON ) ]  
Set Variable [ $arch ; Value: JSONGetElement ( $plugin_json ; "environment.architecture" ) ]  
Set Variable [ $platform ; Value: GetAsNumber ( JSONGetElement ( $plugin_json ; "environment.platform" ) ) ]  
  
# macOS  
If [ $platform = 1 ]  
    If [ $arch = "arm64" ]  
        # Apple silicon  
        Install Plug-In File [ Plugins::macOS_Universal ]  
    Else If [ $arch = "x86_64" and IsEmpty ( Plugins::macOS_Universal ) ]  
        # Intel and no Universal plug-in available  
        Install Plug-In File [ Plugins::macOS_Intel ]  
    Else  
        # Intel and Universal plug-in available  
        Install Plug-In File [ Plugins::macOS_Universal ]  
    End If  
    Exit Script [ Text Result: "Plug-in for macOS installed" ]  
End If  
  
# Windows  
If [ $platform = -2 ]  
    Install Plug-In File [ Plugins::Windows_64bit ]  
    Exit Script [ Text Result: "Plug-in for Windows installed" ]  
End If  
  
# Linux  
If [ $platform = 5 ]  
    If [ PatternCount ( Get ( HostApplicationVersion ) ; "Cloud Server 2" ) > 0 ]  
    Else  
        Install Plug-In File [ Plugins::Linux ]  
        Exit Script [ Text Result: "Plug-in for Linux installed" ]  
    End If  
End If  
  
Show Custom Dialog [ "Plug-ins are not supported on this platform." ]
```

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

### Example 1: Display dialog when lowercase 'a' is entered

Source: https://help.claris.com/en/pro-help/content/get-triggermodifierkeys.html

This FileMaker script shows a custom dialog only when the keystroke is lowercase 'a' and no modifier keys are pressed. It uses Get(TriggerKeystroke) and Get(TriggerModifierKeys) together.

```filemaker
If [ Get ( TriggerKeystroke ) = "a" and Get ( TriggerModifierKeys ) = 0 ]  
    Show Custom Dialog ["You entered \"a\"."]  
End If
```

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

### Example Output on macOS

Source: https://help.claris.com/en/pro-help/content/get-opendatafileinfo.html

Example output when two data files are open on macOS. File IDs are returned by the Open Data File script step.

```plaintext
15        file:/Macintosh HD/Users/user_name/Documents/change.log  
16        file:/Macintosh HD/Users/user_name/Desktop/sap001.txt
```
Tokens:
Raw