Topics   All   Mac OS X (Only)   Windows (Only)   Linux (Only, Not)   iOS (Only, Not)  
Components   Crossplatform Mac & Win   Server   Client   Old   Guides   Examples
New in version: 8.2   8.3   8.4   8.5   9.0   9.1   9.2   9.3   9.4   9.5    Statistic  

FM.RunDatabaseDesignReport

Performs a data design report automatically.

Component Version macOS Windows Server FileMaker Cloud FileMaker iOS SDK
FM 5.0 Yes Yes No No No
MBS( "FM.RunDatabaseDesignReport"; UseXML { ; Path; OpenWhenDone; FileNames } )   More

(old name: FM.RunDataDesignReport)

Parameters

Parameter Description Example value
UseXML Pass 1 to use XML or 0 to use HTML for the report. 1
Path Optional
The path where to save for MacOS.
If you don't specify a path, the last one used in the dialogs will be used.
"/tmp"
OpenWhenDone Optional
Whether to open file when done.
Pass 1 to open file after creating DDR or 0 to not open.
Default is 0.
0
FileNames Optional
Available in MBS FileMaker Plugin 9.4 or newer.
The list of filenames to set checkmarks for.
Names must match exactly to be checked.
MacOS only.
"test.fmp12¶other.fmp12"

Result

Returns OK or error.

Description

Performs a data design report automatically.
This must be the last step in a script, because it triggers an asynchronously process to make a report. So the plugin will run the menu command, set the options, press the create button and the save button for you.
If you like to run other things later, simply run a script 5 seconds later with FM.RunScriptLater.

FileMaker and the dialogs may need to be frontmost to have this work well.

May not work if debugger window is visible.
See also FM.RunSaveAsXML for FileMaker 18.

This function requires a native path. Use Path.FileMakerPathToNativePath to convert a FileMaker path to a native path if required. If you like to have the user choose the path, you can use FileDialog functions.

Examples

Make a XML report to temp folder on Mac:

Set Variable [$r; Value:MBS( "FM.RunDataDesignReport"; 1; "/tmp" )]

Export to desktop:

Set Variable [$r; Value:MBS( "FM.RunDataDesignReport"; 1; "/Users/cs/Desktop" )]
// please change path!

See also

Blog Entries

Release notes

Created 15th November 2014, last changed 10th August 2019


FM.QueryTableNames   -   FM.RunSaveAsXML

Feedback: Report problem or ask question.




Links
MBS Xojo Plugins