360Works ScriptMaster 6.1 User Guide

Introduction

Note: FileMaker 18 requires plugins to be signed in order to work correctly. This directly impacts custom plugins made with ScriptMaster. For more information see here: ScriptMaster Documentation

ScriptMaster is a free, general-purpose, modular plugin. It includes modules for file manipulation (reading, writing, copying, deleting, zipping/unzipping, and moving files on the hard drive); downloading URLs and submitting forms online; XML Web Services; shell scripting; and many others including screen capture, encryption, SQL access and clipboard access. Modules for ScriptMaster are written in a programming language called Groovy, which is very similar to Java. Because they are so similar, we often use the terms Java and Groovy interchangeably in this documentation, although it is more technically accurate to refer to it as Groovy. You do not need to be a Java programmer to use ScriptMaster, but if you are, you can write your own modules or enhance the ones that come with it.

ScriptMaster modules work just like FileMaker custom functions: You pass in some inputs and get back an output. They appear in your FileMaker function list, just like custom functions.

In other ways, however, they improve on what you can do with custom functions. Custom functions only allow you to do things you can already do with features built into FileMaker, but ScriptMaster modules can access all of the power in the Java language and class libraries. It's also easier to share ScriptMaster modules across all of your FileMaker files than sharing custom functions, because custom functions must be duplicated into every FileMaker file, while ScriptMaster modules are available to every file running in FileMaker.

To get started with ScriptMaster, install the ScriptMaster plugin by copying it into your FileMaker extensions directory (complete installation instructions can be found below). Then open the ScriptMaster.fmp12 file that comes with it. At the top, click on 'ScriptMaster Modules' which will show you a list of all of the modules that come with ScriptMaster listed in order by Category. To try one out, click on it in the list view. 'Screen Capture' under the 'Containers' Category is a good one to start with. This module will take a picture of some section of your screen and store it into a container field in FileMaker. You supply parameters for left, top, width, and height, which tells the module which section of your screen to capture. This is a good module to start with because the Java code is very short and easy to understand, and it also demonstrates how to work with data in container fields. Click the 'Run Script' button with the green arrow to run the module, which will run the module based on the values set for the input variables. After you run this, you should see a screen shot in the result area at the bottom of the screen (click on 'Enlarge' to see the full screen shot). Experiment with changing the inputs (left, top, width, and height) to see the result, and try out some of the other modules that come with ScriptMaster.

Registering Modules As Functions

The 'Run Script' button is a very easy way to try out modules in the development file, but it's not how you would use it within your own FileMaker solution. For that, we'll talk about registering this module as a function, which makes the module appear in your list of available FileMaker functions. Because it compiles the code, it will also run much faster as a registered function than by using the 'Run Script' button. To register a module, simply click the 'Register Function' button at the bottom of any module's screen. This compiles the code for the module, adds it to the list of available FileMaker functions, and takes you to a screen showing that the module has been registered successfully. You can see your registered ScriptMaster functions anywhere you'd get a calculation dialog in FileMaker (such as a calculation field or a 'set variable' script step) by pulling down to the 'External functions' grouping. The registered function will appear under the 'ScriptMaster' section, and can be called just like any other built-in FileMaker function.

Now that you've registered the function, you're almost ready to start using it in your solution. The only problem is that functions only remain registered while FileMaker is running - if you were to quit FileMaker and start it back up, the module you just registered would no longer appear in the FileMaker functions list. We'll discuss three options for registering ScriptMaster modules every time you open your solution file.

The first option requires ScriptMaster Advanced Edition. This is available for purchase for $95 per developer per year from http://www.360works.com/scriptmaster, and is included in the 360Works Portfolio License Bundle. See the licensing section for more details. With the Advanced Edition, click the 'plugin generation' button from the registration screen or the top of any other screen. This will create a new plugin that you can name whatever you want and distribute to your customers along with your FileMaker solutions royalty-free. This plugin is completely self-contained, and does not require either the ScriptMaster plugin or the ScriptMaster.fmp12 FileMaker file.

The second option is to simply check the 'register on startup' box from the registration screen (the layout that you are taken to after clicking the 'register' button). All modules with this option enabled are registered every time you open the ScriptMaster.fmp12 file, so you can just include the ScriptMaster.fmp12 file with your solution, open it in your startup script, and then immediately close it (it doesn't need to stay open after the functions have been registered). Here's an example of what you would put in your startup script:

 Open File ["ScriptMaster"]
 Close File ["ScriptMaster"]
 

The third option is the most complex, but it does not require ScriptMaster Advanced Edition, and it does not require you to include the ScriptMaster.fmp12 file with your solution. In the module registration screen, click the button that says 'Copy to clipboard', which puts all of the registration code onto your clipboard. Now go to the startup script in your FileMaker solution, add a 'set variable' script step (you can name the variable anything you like), and paste in the registration code as the formula to calculate. Now the function will be registered every time that your startup script runs. Here's what that script step would look like:

 Set Variable [$result; Value:RegisterGroovy( "GetURLasText( url )"; "new URL(url).getText();" )]
 

It is a good idea to check for errors after registering the function, in case there is any problem compiling the Java code. See the section below on error reporting, or watch the Youtube movie in this documentation to see an example of this complete setup. Here is an example that does the same thing as the previous one, but checks for errors and displays them to the user in case the function cannot be compiled:

 If [RegisterGroovy( "GetURLasText( url )"; "new URL(url).getText();" ) = "ERROR"]
 Show Custom Dialog ["Could not register ScriptMaster function"; SMLastError]
 End If
 

Licensing and pricing

There is also a ScriptMaster Advanced Edition available. This is available for purchase for $95 per developer per year from http://www.360works.com/scriptmaster. If you own a 360Works Portfolio License, that includes ScriptMaster Advanced for one developer. Purchasing the advanced edition gives you all the same features as the free version, plus three new capabilities:

• The Advanced Edition will allow you to easily generate your own branded plugins. Just register the modules you want and click the 'Make Plugin' button, and you've got a plugin with all of your favorite modules pre-compiled into it. You can distribute this generated plugin royalty-free with all of your custom solutions.
• The Advanced Edition allows direct access to the FileMaker SQL engine, which allows you to execute SQL commands directly from any script.
• The Advanced Edition allows direct access to the FileMaker clipboard, allowing you to read clipboard contents at runtime. You can even modify the clipboard items and then push the modified versions back onto the clipboard.

Plugins created with ScriptMaster Advanced cannot be distributed by themselves, for free or commercially. They can only be distributed with a FileMaker Solution that utilizes the plugin. The FileMaker Solution cannot be just a wrapper or demo of the plugin functionality, it must be a full-fledged solution in its own right that uses the plugin for additional functionality.

Plugins created with ScriptMaster Advanced can utilize the SQL and Clipboard features. Once generated, they will never expire. However, the ScriptMaster Advanced plugin itself will not be able to generate new plugins after one year until the license key is renewed for an annual cost of $95 per developer.

Tutorial video

We've created a video showing how to use ScriptMaster. This is a quick (8:15 minute) jump-start showing you how to create a plugin with ScriptMaster Advanced and use it to screen scrape images from a web site.

Loading modules from the Internet

ScriptMaster 4 has added a new feature to load ScriptMaster modules from a network URL. You can use the SMLoadJar function to register all ScriptMaster modules found in the jar file. The jar file can also contain 3rd party classes referenced by the ScriptMaster modules in that jar file. Todd Geist has published his set of commonly used ScriptMaster modules at this URL:

http://www.360works.com/static/ScriptMaster/core/plugin.jar

If you would like to publish your own favorite ScriptMaster modules for others to share, please read the SMLoadJar function description for instructions on this.

Advanced techniques

Your ScriptMaster functions can reference compiled Java libraries (stored in the .jar format) by using the SMLoadJar function. Pass in a container field containing a .jar file, or a URL pointing to a .jar file, and any scripts you execute will have access to the classes in that .jar. This means you can access libraries like iText (a powerful PDF manipulation library) or qtjava (QuickTime for Java) from within FileMaker. You could also easily write your own java code, package it as a .jar, and distribute it with your FileMaker solution! And since the .jar is stored in FileMaker, deploying new versions of the java code to the FileMaker clients is as easy as updating a single container field.

Keep in mind that if you are copying and pasting the function registration into your startup script, and that module requires any jar libraries, you will need to add those jar files to container fields in your solution and use SMLoadJar to load them before registering the function. This is not an issue if using the 'register on startup' option with the ScriptMaster.fp7 development file, since that file includes all of the jar files needed for the modules that come with ScriptMaster.

After a ScriptMaster function executes, you can access any of the named variables which were set during execution using the SMGetVariable function. This can be very useful for returning multiple output values, similar to setting global variables in a FileMaker script.

Getting help

If you get the word 'ERROR' as the result of a ScriptMaster function, be sure to read the section below on Error reporting for how to get more information on that.

Phone and e-mail support for ScriptMaster are available at our standard hourly rate of $165. There is also a free ScriptMaster discussion forum where you can get help from the growing community of ScriptMaster users.

If you create your own module that you think would be useful to others, post it on the fmforums discussion group! If it seems like it will have broad appeal, we'll include it with the next release of ScriptMaster (preference will be given to modules that do not require 3rd party libraries).

Writing your own modules

In addition to the many existing modules that come free with ScriptMaster, 360Works is available to create custom modules suited to your specific needs. Send us an email ( plugins@360works.com ) or give us a call at 770-234-9293 and let us know what you're looking for, and we'll get you an estimate at no charge.

The other choice is to do it yourself! We want to start off by stressing that you can skip the rest of this section if you're not interested in learning Groovy or Java. ScriptMaster comes with tons of useful modules that you can use without having to learn a new programming language. However, if the built in modules have stirred your curiosity, you'll be able to take your FileMaker solutions to a whole new level with the power of Groovy and Java. Because Groovy is cross-platform, modules you create will run on both Windows and Mac OS X.

To create your own module, just create a new record from the menu. Give it a title and start coding! You can learn about Groovy at http://groovy.codehaus.org/Beginners+Tutorial (you can skip all of the steps about setting up your Java and Groovy environment; that's all taken care of by ScriptMaster).

Here are a few tips about using ScriptMaster with FileMaker:

In the 'Screen Capture' module, one thing you'll notice is that the Integer.valueOf() calls at the beginning. This is because all ScriptMaster functions are transmitted as text. The Integer.valueOf(someText) translates this into a numeric value. Java is much stricter about data types than FileMaker, so this can take some getting used to for FileMaker programmers.

In addition to setting variables prior to script execution, you can access the FileMaker calculation engine directly from within your Groovy script. This is accomplished using the reserved fmpro object. Every Groovy script which is executed will have an fmpro variable set to an instance of an FMPro object, which has these important methods:

evaluate(fmcalculation)

Evaluates the supplied FileMaker calculation text, returning the result as a String. The fmcalculation parameter can be any valid FileMaker calculation string.

performScript(fileName, scriptName [ , paramString ])

Performs a FileMaker script in the current file, passing in the optional paramString as a parameter. Note: fileName is required.

merge(template)

Processes some text with merge fields embedded, replacing the merge fields with their evaluated values. An example of a merge field is <<table::field>>. If an error occurs during evaluation, the field is left as is.

getContainerStream( fieldName )

Gets an input stream with bytes from the container field. Be sure to pass in the NAME of the container field, ie fmpro.getContainerStream( "Person::Photo" )

getContainerFileName( fieldName )

Gets the name of the file stored in a container field. Be sure to pass in the NAME of the container field, ie fmpro.getContainerFileName( "Person::Photo" ) might return 'jesse.jpg'

executeSql(sql, columnDelimiter, rowDelimiter)

Advanced Edition only: Executes the SQL code in the current FileMaker file. The results are returned as delimited text, using the provided delimiters.

executeSqlArray(sql)

Advanced Edition only: Executes the SQL code in the current FileMaker file. The results are returned as a String[][] array. If you're going to be processing the results within your Groovy code, this is simpler to work with than getting delimited text.

getClipboardFormats

Advanced Edition only: Gets the list of available formats for the current clipboard data.

getBestFileMakerClipboardFormat

Advanced Edition only: Gets the format id corresponding to the XML FileMaker clipboard data

getClipboardContents( format )

Advanced Edition only: Gets the clipboard data for the requested format.

setClipboardContents( format, data )

Advanced Edition only: Sets the clipboard data for the requested format.

setFileMakerClipboard( data )

Advanced Edition only: Sets the clipboard data from the supplied FileMaker XML data. This will parse the XML data to determine what type of data it is, so a format specifier is not required.

A script evaluated in ScriptMaster always returns the value of the last line, or the value which is implicitly returned by the script. This can be any type of Java object. ScriptMaster does its best to convert this to a FileMaker object.

The following conversions occur:

• Strings and Readers are returned as Filemaker TEXT fields, with newline characters (\n) converted to carriage returns (\r). If you are returning a very large block of text, you should return a Reader, which streams in chunks so that it will not run out of memory.
• Numbers and numeric primitives are returned as FileMaker NUMBER fields
• Boolean values are returned as a 0 or 1
• File objects are converted to embedded containers
• Arrays and Collections are converted to return-separated lists
• URLs are converted to embedded containers
• Colors are converted to a string like RGB(204,102,255)
• RenderedImage, BufferedImage are converted to container images. If the image has transparency, it is converted to a PNG image. Otherwise it is converted to a JPEG.
• FMType objects are returned as-is.
• Any other object is converted to a String and returned as Text.