Monkeybread Software - MBS FileMaker Plugin: XL Test

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

MBS FileMaker Plugin Example Databases

XL Test

All examples are included with download of MBS FileMaker Plugin.

XL Test.fmp12

Overview
Tables	2
Relationships	0
Layouts	3
Scripts	6
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
XL	3 fields defined, 1 record	XL
Images	4 fields defined, 0 record	Images

Fields

Table Name: XL - 3 Fields
Field Name	Type	Options	Comments	On Layouts	In Relationships	In Scripts	In Value Lists
ExcelFile	Normal, Binary	Auto-Enter: Allow editing Validation: Only during data entry Storage: Repetitions: 1		XL		GetText Get CSV via Matrix Get Images
Text	Normal, Text	Auto-Enter: Allow editing Validation: Only during data entry Storage: Repetitions: 1 Indexing: None Automatically create indexes as needed Index Language: German		XL		GetText Clear Get CSV via Matrix
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				Clear Get Images

Table Name: Images - 4 Fields
Field Name	Type	Options	Comments	On Layouts	In Relationships	In Scripts	In Value Lists
PrimaryKey	Normal, Text	Auto-Enter: Context table: Images Calculation: Get( UUID ) Validation: Only during data entry Not empty Unique Strict validation Storage: Repetitions: 1 Indexing: Minimal Automatically create indexes as needed Index Language: Unicode Raw	Unique identifier of each record in this table
Index	Normal, Number	Auto-Enter: Allow editing Validation: Only during data entry Storage: Repetitions: 1 Indexing: None Automatically create indexes as needed Index Language: German		Images		Get Images
Picture	Normal, Binary	Auto-Enter: Allow editing Validation: Only during data entry Storage: Repetitions: 1		Images		Get Images
Picture Type	Normal, Text	Auto-Enter: Allow editing Validation: Only during data entry Storage: Repetitions: 1 Indexing: None Automatically create indexes as needed Index Language: German		Images		Get Images

Layout Objects: XL

Regular Fields

Field Name: XL::ExcelFile

Layout Name:

Top: 42 pt
Left: 138 pt
Bottom: 167 pt
Right: 391 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: System Default
Go to next field using: Tab key

Layout Name:

Top: 171 pt
Left: 138 pt
Bottom: 364 pt
Right: 391 pt

Anchoring: Left and Right, Top and Bottom

Field Format:

Edit Box

Field Behavior:

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

Type:

Text: MBS Plugin Website

Layout Name:

Top: 407 pt
Left: 11 pt
Bottom: 433 pt
Right: 164 pt

Anchoring: Left, Top

Open URL [ "http://monkeybreadsoftware.de/filemaker/" ] [ No dialog ]

Button Properties

Coordinates

Script/Script Step

Type:

Text: Order LibXL License

Layout Name:

Top: 407 pt
Left: 172 pt
Bottom: 433 pt
Right: 325 pt

Anchoring: Left, Top

Open URL [ "http://monkeybreadsoftware.de/filemaker/xl.shtml" ] [ No dialog ]

Button Properties

Coordinates

Script/Script Step

Type:

Text: Extract text from Excel file

Layout Name:

Top: 53 pt
Left: 406 pt
Bottom: 87 pt
Right: 628 pt

Anchoring: Right, Top

Perform Script [ “GetText” ]

Scripts:

GetText

Button Properties

Coordinates

Script/Script Step

Type:

Text: Extract CSV from Excel file

Layout Name:

Top: 101 pt
Left: 406 pt
Bottom: 135 pt
Right: 628 pt

Anchoring: Right, Top

Perform Script [ “Get CSV via Matrix” ]

Scripts:

Get CSV via Matrix

Button Properties

Coordinates

Script/Script Step

Type:

Text: Extract Images

Layout Name:

Top: 149 pt
Left: 406 pt
Bottom: 183 pt
Right: 628 pt

Anchoring: Right, Top

Perform Script [ “Get Images” ]

Scripts:

Get Images

Layout Objects: Images

Regular Fields

Field Name: Images::Index

Layout Name:

Images

Top: 59 pt
Left: 138 pt
Bottom: 90 pt
Right: 391 pt

Anchoring: Left, 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: Images::Picture

Layout Name:

Images

Top: 94 pt
Left: 138 pt
Bottom: 333 pt
Right: 771 pt

Anchoring: Left and Right, Top and Bottom

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

Field Name: Images::Picture Type

Layout Name:

Images

Top: 59 pt
Left: 518 pt
Bottom: 90 pt
Right: 771 pt

Anchoring: Left, 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: Back

Layout Name:

Images

Top: 11 pt
Left: 759 pt
Bottom: 42 pt
Right: 868 pt

Anchoring: Right, Top

Go to Layout [ “XL” (XL) ]

Layouts:

Script Name	GetText
Run script with full access privileges	Off
Siri Shortcut Visible	Off
Include In Menu	Yes
Layouts that use this script	XL
Scripts that use this script
Script Definition
Script Steps	If [ MBS("XL.IsInitialized") ≠ 1 ] Perform Script [ “InitXL” ] End If Set Variable [ $bookRef; Value:MBS( "XL.LoadBook"; XL::ExcelFile) ] If [ MBS("IsError") ] Show Custom Dialog [ Title: "Error"; Message: $bookRef; Default Button: “OK”, Commit: “Yes”; Button 2: “Cancel”, Commit: “No” ] Exit Script [ ] End If Set Variable [ $text; Value:MBS( "XL.Book.GetText"; $bookRef) ] Set Field [ XL::Text; $text ] Set Variable [ $r; Value:MBS( "XL.Book.Release"; $bookRef) ]
Fields used in this script	XL::ExcelFile XL::Text
Scripts used in this script	InitXL
Layouts used in this script
Tables used in this script	XL
Table occurrences used by this script	XL
Custom Functions used by this script
Custom menu set used by this script

Previous Script: [GetText]

Next Script: [Trace]

Script Name	Clear
Run script with full access privileges	Off
Siri Shortcut Visible	Off
Include In Menu	Yes
Layouts that use this script
Scripts that use this script
Script Definition
Script Steps	#clear all data Go to Layout [ “XL” (XL) ] Replace Field Contents [ XL::Text; Replace with calculation: "" ] [ No dialog ] Replace Field Contents [ XL::Result; Replace with calculation: "" ] [ No dialog ] Go to Layout [ “Images” (Images) ] Delete All Records [ No dialog ] Go to Layout [ original layout ]
Fields used in this script	XL::Text XL::Result
Scripts used in this script
Layouts used in this script	XL Images
Tables used in this script	XL
Table occurrences used by this script	XL
Custom Functions used by this script
Custom menu set used by this script

Previous Script: [Clear]

Next Script: [InitXL]

Script Name	Trace
Run script with full access privileges	Off
Siri Shortcut Visible	Off
Include In Menu	Yes
Layouts that use this script
Scripts that use this script
Script Definition
Script Steps	#Trace logging is useful for debugging Set Variable [ $Trace; Value:MBS("Trace") ]
Fields used in this script
Scripts used in this script
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: [Trace]

Next Script: [Get CSV via Matrix]

Script Name	InitXL
Run script with full access privileges	Off
Siri Shortcut Visible	Off
Include In Menu	Yes
Layouts that use this script
Scripts that use this script	GetText Get CSV via Matrix Get Images
Script Definition
Script Steps	#Find libXL and load it #you can have libraries in container and export at runtime to folder of your choice. #Or install library somewhere and pass path. #If library is in same folder as plugin, you can only pass only file name. If [ MBS("IsServer") ] #Put the path you use for your server here: If [ Get(SystemPlatform) = -2 ] #Server on Windows Set Variable [ $path; Value:"C:\Programs\FileMaker Server\libxl.dll" ] Else If [ MBS("IsLinux") ] #Server on Linux for FileMaker Cloud Set Variable [ $path; Value:"/opt/FileMaker/FileMaker Server/libxl.so" ] Else #Server on Mac Set Variable [ $path; Value: "/Library/FileMaker Server/libxl.dylib" ] End If Else #For desktop and our examples we look in same folder as database: Set Variable [ $databasePath; Value:Get(FilePath) ] Set Variable [ $databasePath; Value:MBS("Path.FilemakerPathToNativePath"; $databasePath) ] Set Variable [ $databasePath; Value:Substitute ( $databasePath ; ".fp7" ; ".fmp12") ] Set Variable [ $databaseName; Value:Get(FileName) & ".fmp12" ] If [ Get(SystemPlatform) = -2 ] Set Variable [ $path; Value:Substitute ( $databasePath ; $databaseName ; "libxl.dll" ) ] #plugin will look for libxl.dll and if not found also for libxl64.dll (64-bit) and libxl32.dll (32-bit). Else Set Variable [ $path; Value:Substitute ( $databasePath ; $databaseName ; "libxl.dylib" ) ] #Mac dylib is usually 32 and 64 bit together. End If End If #You can test for free. #If you like to get a LibXL license, please follow links on our pricing page: #https://www.monkeybreadsoftware.de/filemaker/pricing.shtml Set Variable [ $LicenseeName; Value:"your name" ] Set Variable [ $LicenseKey; Value:"your LibXL license key" ] Set Variable [ $r; Value:MBS( "XL.Initialize"; $path; $LicenseeName; $LicenseKey) ] If [ $r ≠ "OK" ] Show Custom Dialog [ Title: "Error"; Message: $r; Default Button: “OK”, Commit: “No”; Button 2: “Cancel”, Commit: “No” ] Halt Script End If
Fields used in this script
Scripts used in this script
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: [InitXL]

Next Script: [Get Images]

Script Name	Get CSV via Matrix
Run script with full access privileges	Off
Siri Shortcut Visible	Off
Include In Menu	Yes
Layouts that use this script	XL
Scripts that use this script
Script Definition
Script Steps	If [ MBS("XL.IsInitialized") ≠ 1 ] Perform Script [ “InitXL” ] End If Set Variable [ $bookRef; Value:MBS( "XL.LoadBook"; XL::ExcelFile) ] If [ MBS("IsError") ] Show Custom Dialog [ Title: "Error"; Message: $bookRef; Default Button: “OK”, Commit: “Yes”; Button 2: “Cancel”, Commit: “No” ] Exit Script [ ] End If Set Variable [ $book; Value:$bookRef ] Set Variable [ $sheet; Value:0 ] #find the range we like to get Set Variable [ $firstRow; Value:MBS( "XL.Sheet.GetFirstRow"; $book; $sheet ) ] Set Variable [ $lastRow; Value:MBS( "XL.Sheet.GetLastRow"; $book; $sheet ) ] Set Variable [ $firstCol; Value:MBS( "XL.Sheet.GetFirstCol"; $book; $sheet ) ] Set Variable [ $lastCol; Value:MBS( "XL.Sheet.GetLastCol"; $book; $sheet ) ] #read cells to a new matrix Set Variable [ $matrix; Value:MBS( "XL.Sheet.ReadCellsAsMatrix"; $bookRef; $sheet; $firstRow; $lastRow; $firstCol; $lastCol) ] #and get CSV from those cells Set Variable [ $text; Value:MBS( "Matrix.CSV"; $matrix; 0; MBS( "Matrix.Height"; $matrix )-1; 0; MBS( "Matrix.Width"; $matrix )-1; ¶; ";" ) ] Set Field [ XL::Text; $text ] #cleanup Set Variable [ $r; Value:MBS( "Matrix.Release"; $matrix) ] Set Variable [ $r; Value:MBS( "XL.Book.Release"; $bookRef) ]
Fields used in this script	XL::ExcelFile XL::Text
Scripts used in this script	InitXL
Layouts used in this script
Tables used in this script	XL
Table occurrences used by this script	XL
Custom Functions used by this script
Custom menu set used by this script

Previous Script: [Get CSV via Matrix]

Script Name	Get Images
Run script with full access privileges	Off
Siri Shortcut Visible	Off
Include In Menu	Yes
Layouts that use this script	XL
Scripts that use this script
Script Definition
Script Steps	If [ MBS("XL.IsInitialized") ≠ 1 ] Perform Script [ “InitXL” ] End If Set Variable [ $bookRef; Value:MBS( "XL.LoadBook"; XL::ExcelFile) ] Set Field [ XL::Result; $bookRef ] If [ MBS("IsError") ] Show Custom Dialog [ Title: "Error"; Message: $bookRef; Default Button: “OK”, Commit: “Yes”; Button 2: “Cancel”, Commit: “No” ] Exit Script [ ] End If Go to Layout [ “Images” (Images) ] If [ Get(LastError) = 0 ] #clear Delete All Records [ No dialog ] Set Variable [ $count; Value:MBS( "XL.Book.PictureCount"; $bookref ) ] Set Variable [ $index; Value:0 ] If [ $index < $count ] Loop [ Flush: Always ] #your script steps here Set Variable [ $type; Value:MBS( "XL.Book.GetPictureType"; $bookRef; $index ) ] Set Variable [ $picture; Value:MBS( "XL.Book.GetPicture"; $bookRef; $index ) ] New Record/Request Set Field [ Images::Picture; $picture ] Set Field [ Images::Picture Type; $type ] Set Field [ Images::Index; $index ] Commit Records/Requests [ No dialog ] #next Set Variable [ $index; Value:$index + 1 ] Exit Loop If [ $index ≥ $count ] End Loop End If End If Go to Record/Request/Page [ First ] Set Variable [ $r; Value:MBS( "XL.Book.Release"; $bookRef) ]
Fields used in this script	XL::ExcelFile XL::Result Images::Picture Images::Picture Type Images::Index
Scripts used in this script	InitXL
Layouts used in this script	Images
Tables used in this script	Images XL
Table occurrences used by this script	Images XL
Custom Functions used by this script
Custom menu set used by this script

Download example: XL Test

Used functions: