Monkeybread Software - MBS FileMaker Plugin: FileOperation

Components	All	New	MacOS		Windows		Linux		iOS
Examples	Mac & Win		Server	Client	Guides	Statistic	FMM	Blog	Deprecated	Old

MBS FileMaker Plugin Example Databases

FileOperation

All examples are included with download of MBS FileMaker Plugin.

FileOperation.fmp12

Overview
Tables	1
Relationships	0
Layouts	1
Scripts	5
Value Lists	0
Custom Functions	0
Custom Menus	33

File Options
Default custom menu set	[Standard FileMaker Menus]
When opening file
Minimum allowed version	12.0
Login using	Account Name; Account= Admin
Allow user to save password	Off
Require iOS passcode	Off
Switch to layout	Off
Hide all toolbars	Off
Script triggers
OnFirstWindowOpen	Off
OnLastWindowClose	Off
OnWindowOpen	Off
OnWindowClose	Off
OnFileAVPlayerChange	Off
Thumbnail Settings
Generate Thumbnails	On; Temporary

Tables

Table Name	Statistics	Occurrences in Relationship Graph
FileOperation	3 fields defined, 1 record	FileOperation

Fields

Table Name: FileOperation - 3 Fields
Field Name	Type	Options	Comments	On Layouts	In Relationships	In Scripts	In Value Lists
SourcePath	Normal, Text	Auto-Enter: Allow editing Validation: Only during data entry Storage: Repetitions: 1 Indexing: None Automatically create indexes as needed Index Language: German		FileOperation		Move File Copy File Move To Trash CopyFolder
DestinationPath	Normal, Text	Auto-Enter: Allow editing Validation: Only during data entry Storage: Repetitions: 1 Indexing: None Automatically create indexes as needed Index Language: German		FileOperation		Move File Copy File CopyFolder
Result	Normal, Text	Auto-Enter: Allow editing Validation: Only during data entry Storage: Repetitions: 1 Indexing: None Automatically create indexes as needed Index Language: German		FileOperation		Move File Copy File Move To Trash

Layout Objects: FileOperation

Regular Fields

Field Name: FileOperation::SourcePath

Layout Name:

FileOperation

Top: 8 pt
Left: 157 pt
Bottom: 27 pt
Right: 410 pt

Anchoring: Left and Right, Top

Field Format:

Edit Box

Field Behavior:

Allow field to be entered: In Find mode, In Browse mode
Touch keyboard type: Default for Data Type
Go to next field using: Tab key

Yes

Field Name: FileOperation::DestinationPath

Layout Name:

FileOperation

Top: 31 pt
Left: 157 pt
Bottom: 50 pt
Right: 410 pt

Anchoring: Left and Right, Top

Field Format:

Edit Box

Field Behavior:

Allow field to be entered: In Find mode, In Browse mode
Touch keyboard type: Default for Data Type
Go to next field using: Tab key

Yes

Field Name: FileOperation::Result

Layout Name:

FileOperation

Top: 54 pt
Left: 157 pt
Bottom: 73 pt
Right: 410 pt

Anchoring: Left and Right, Top

Field Format:

Edit Box

Field Behavior:

Allow field to be entered: In Find mode, In Browse mode
Touch keyboard type: Default for Data Type
Go to next field using: Tab key

Type:

Text: Move to Trash

Layout Name:

FileOperation

Top: 87 pt
Left: 40 pt
Bottom: 114 pt
Right: 200 pt

Anchoring: Left, Top

Perform Script [ “Move To Trash” ]

Scripts:

Move To Trash

Button Properties

Coordinates

Script/Script Step

Type:

Text: Copy File/Folder

Layout Name:

FileOperation

Top: 87 pt
Left: 250 pt
Bottom: 114 pt
Right: 410 pt

Anchoring: Left, Top

Perform Script [ “Copy File” ]

Scripts:

Copy File

Button Properties

Coordinates

Script/Script Step

Type:

Text: Move File/Folder

Layout Name:

FileOperation

Top: 128 pt
Left: 40 pt
Bottom: 155 pt
Right: 200 pt

Anchoring: Left, Top

Perform Script [ “Move File” ]

Scripts:

Move File

Button Properties

Coordinates

Script/Script Step

Type:

Text: Copy Folder recursively

Layout Name:

FileOperation

Top: 128 pt
Left: 250 pt
Bottom: 155 pt
Right: 410 pt

Anchoring: Left, Top

Perform Script [ “CopyFolder” ]

Scripts:

CopyFolder

Next Script: [Copy File]

Script Name	Move File
Run script with full access privileges	Off
Include In Menu	Yes
Layouts that use this script	FileOperation
Scripts that use this script
Script Definition
Script Steps	Set Variable [ $result; Value:MBS("Files.MoveFile"; FileOperation::SourcePath; FileOperation::DestinationPath) ] Set Field [ FileOperation::Result; $result ]
Fields used in this script	FileOperation::SourcePath FileOperation::DestinationPath FileOperation::Result
Scripts used in this script
Layouts used in this script
Tables used in this script	FileOperation
Table occurrences used by this script	FileOperation
Custom Functions used by this script
Custom menu set used by this script

Previous Script: [Move File]

Next Script: [Move To Trash]

Script Name	Copy File
Run script with full access privileges	Off
Include In Menu	Yes
Layouts that use this script	FileOperation
Scripts that use this script
Script Definition
Script Steps	Set Variable [ $result; Value:MBS("Files.CopyFile"; FileOperation::SourcePath; FileOperation::DestinationPath) ] Set Field [ FileOperation::Result; $result ]
Fields used in this script	FileOperation::SourcePath FileOperation::DestinationPath FileOperation::Result
Scripts used in this script
Layouts used in this script
Tables used in this script	FileOperation
Table occurrences used by this script	FileOperation
Custom Functions used by this script
Custom menu set used by this script

Previous Script: [Copy File]

Next Script: [CopyFolder Recursive]

Script Name	Move To Trash
Run script with full access privileges	Off
Include In Menu	Yes
Layouts that use this script	FileOperation
Scripts that use this script
Script Definition
Script Steps	Set Variable [ $result; Value:MBS("Files.MoveToTrash"; FileOperation::SourcePath) ] Set Field [ FileOperation::Result; $result ]
Fields used in this script	FileOperation::SourcePath FileOperation::Result
Scripts used in this script
Layouts used in this script
Tables used in this script	FileOperation
Table occurrences used by this script	FileOperation
Custom Functions used by this script
Custom menu set used by this script

Previous Script: [Move To Trash]

Next Script: [CopyFolder]

Script Name	CopyFolder Recursive
Run script with full access privileges	Off
Include In Menu	No
Layouts that use this script
Scripts that use this script	CopyFolder Recursive CopyFolder
Script Definition
Script Steps	Set Variable [ $json; Value:Get(ScriptParameter) ] #query the input and output paths we got Set Variable [ $SourcePath; Value:MBS( "JSON.GetPathItem"; $json; "SourcePath"; 3) ] Set Variable [ $DestPath; Value:MBS( "JSON.GetPathItem"; $json; "DestPath"; 3) ] Set Variable [ $Recursion; Value:MBS( "JSON.GetPathItem"; $json; "Recursion"; 3) ] If [ IsEmpty($Recursion) ] #called by user, so check input #check source Set Variable [ $r; Value:MBS( "Files.DirectoryExists"; $SourcePath ) ] If [ $r ≠ 1 ] Set Variable [ $json; Value:MBS( "JSON.AddStringToObject"; $json; "Error"; "Invalid source path") ] Set Variable [ $json; Value:MBS( "JSON.AddStringToObject"; $json; "ErrorDetail"; $r) ] Exit Script [ Result: $json ] End If #check dest. Create as folder. If already exists, this will not be an error Set Variable [ $r; Value:MBS( "Files.CreateDirectory"; $DestPath ) ] If [ MBS("IsError") ] Set Variable [ $json; Value:MBS( "JSON.AddStringToObject"; $json; "Error"; "Failed to create directory: " & $DestPath) ] Set Variable [ $json; Value:MBS( "JSON.AddStringToObject"; $json; "ErrorDetail"; $r) ] Exit Script [ Result: $json ] End If Set Variable [ $r; Value:MBS( "Files.DirectoryExists"; $DestPath) ] If [ $r ≠ 1 ] Set Variable [ $json; Value:MBS( "JSON.AddStringToObject"; $json; "Error"; "Invalid destination path") ] Set Variable [ $json; Value:MBS( "JSON.AddStringToObject"; $json; "ErrorDetail"; $r) ] Exit Script [ Result: $json ] End If End If #get directory listing Set Variable [ $list; Value:MBS("Files.List"; $SourcePath) ] If [ MBS("IsError") ] Set Variable [ $json; Value:MBS( "JSON.AddStringToObject"; $json; "Error"; "Failed to get directory listing") ] Set Variable [ $json; Value:MBS( "JSON.AddStringToObject"; $json; "ErrorDetail"; $list) ] Exit Script [ Result: $json ] End If #loop counting up from 1 to $count Set Variable [ $count; Value:ValueCount ( $list ) ] Set Variable [ $index; Value:1 ] If [ $index ≤ $count ] Loop #your script steps here Set Variable [ $ItemName; Value:GetValue($list; $index) ] Set Variable [ $ItemPath; Value:MBS( "Path.AddPathComponent"; $SourcePath; $ItemName ) ] Set Variable [ $ItemDest; Value:MBS( "Path.AddPathComponent"; $DestPath; $ItemName ) ] If [ MBS( "Files.DirectoryExists"; $ItemPath ) ] #copy folder with recursion #create new folder Set Variable [ $r; Value:MBS( "Files.CreateDirectory"; $ItemDest ) ] If [ MBS("IsError") ] Set Variable [ $json; Value:MBS( "JSON.AddStringToObject"; $json; "Error"; "Failed to create directory: " & $ItemDest) ] Set Variable [ $json; Value:MBS( "JSON.AddStringToObject"; $json; "ErrorDetail"; $r) ] Exit Script [ Result: $json ] End If #prepare JSON for recursive call Set Variable [ $jsonCall; Value:"{}" ] Set Variable [ $jsonCall; Value:MBS( "JSON.SetPathItem"; $jsonCall; "SourcePath"; MBS( "JSON.CreateString"; $ItemPath)) ] Set Variable [ $jsonCall; Value:MBS( "JSON.SetPathItem"; $jsonCall; "DestPath"; MBS( "JSON.CreateString"; $ItemDest)) ] Set Variable [ $jsonCall; Value:MBS( "JSON.SetPathItem"; $jsonCall; "Recursion"; "true") ] Perform Script [ “CopyFolder Recursive”; Parameter: $jsonCall ] Set Variable [ $jsonResult; Value:Get(ScriptResult) ] #check error Set Variable [ $Error; Value:MBS( "JSON.GetPathItem"; $jsonResult; "Error"; 3 ) ] If [ Length ( $Error ) > 0 ] #pass back Exit Script [ Result: $jsonResult ] End If #handle statistics Set Variable [ $FilesCopied1; Value:MBS( "JSON.GetPathItem"; $json; "FilesCopied"; 3 ) ] Set Variable [ $FilesCopied2; Value:MBS( "JSON.GetPathItem"; $jsonResult; "FilesCopied"; 3 ) ] Set Variable [ $json; Value:MBS( "JSON.SetPathItem"; $json; "FilesCopied"; $FilesCopied1 + $FilesCopied2) ] Set Variable [ $DirectoriesCopied1; Value:MBS( "JSON.GetPathItem"; $json; "DirectoriesCopied"; 3 ) ] Set Variable [ $DirectoriesCopied2; Value:MBS( "JSON.GetPathItem"; $jsonResult; "DirectoriesCopied"; 3 ) ] Set Variable [ $json; Value:MBS( "JSON.SetPathItem"; $json; "DirectoriesCopied"; $DirectoriesCopied1 + $DirectoriesCopied2 + 1) ] Set Variable [ $BytesCopied1; Value:MBS( "JSON.GetPathItem"; $json; "BytesCopied"; 3 ) ] Set Variable [ $BytesCopied2; Value:MBS( "JSON.GetPathItem"; $jsonResult; "BytesCopied"; 3 ) ] Set Variable [ $json; Value:MBS( "JSON.SetPathItem"; $json; "BytesCopied"; $BytesCopied1 + $BytesCopied2) ] Else #copy one file Set Variable [ $r; Value:MBS( "Files.ReadAndWriteFile"; $ItemPath; $ItemDest ) ] If [ MBS("IsError") ] Set Variable [ $json; Value:MBS( "JSON.AddStringToObject"; $json; "Error"; "Failed to copy file") ] Set Variable [ $json; Value:MBS( "JSON.AddStringToObject"; $json; "ErrorDetail"; $r) ] Exit Script [ Result: $json ] End If #handle statistics Set Variable [ $FileSize; Value:MBS( "Files.FileSize"; $ItemPath ) ] Set Variable [ $FilesCopied; Value:MBS( "JSON.GetPathItem"; $json; "FilesCopied"; 3 ) ] Set Variable [ $json; Value:MBS( "JSON.SetPathItem"; $json; "FilesCopied"; $FilesCopied + 1) ] Set Variable [ $BytesCopied; Value:MBS( "JSON.GetPathItem"; $json; "BytesCopied"; 3 ) ] Set Variable [ $json; Value:MBS( "JSON.SetPathItem"; $json; "BytesCopied"; $BytesCopied + $FileSize) ] End If #next Set Variable [ $index; Value:$index + 1 ] Exit Loop If [ $index > $count ] End Loop End If Exit Script [ Result: $json ]
Fields used in this script
Scripts used in this script	CopyFolder Recursive
Layouts used in this script
Tables used in this script
Table occurrences used by this script
Custom Functions used by this script
Custom menu set used by this script

Previous Script: [CopyFolder Recursive]

Script Name	CopyFolder
Run script with full access privileges	Off
Include In Menu	Yes
Layouts that use this script	FileOperation
Scripts that use this script
Script Definition
Script Steps	Set Variable [ $SourcePath; Value:FileOperation::SourcePath ] Set Variable [ $DestPath; Value:FileOperation::DestinationPath ] Set Variable [ $json; Value:"{}" ] Set Variable [ $json; Value:MBS( "JSON.AddStringToObject"; $json; "SourcePath"; $SourcePath ) ] Set Variable [ $json; Value:MBS( "JSON.AddStringToObject"; $json; "DestPath"; $DestPath ) ] Perform Script [ “CopyFolder Recursive”; Parameter: $json ] Set Variable [ $$result; Value:Get(ScriptResult) ] Show Custom Dialog [ Title: "done"; Message: $$result; Default Button: “OK”, Commit: “Yes” ]
Fields used in this script	FileOperation::SourcePath FileOperation::DestinationPath
Scripts used in this script	CopyFolder Recursive
Layouts used in this script
Tables used in this script	FileOperation
Table occurrences used by this script	FileOperation
Custom Functions used by this script
Custom menu set used by this script

Download example: FileOperation

Used functions: