FileMaker Pro Advanced 11 Development Guide
FileMaker Pro Advanced 11 Development Guide
FileMaker Pro Advanced 11 Development Guide
Development Guide
20072010 FileMaker, Inc. All Rights Reserved. FileMaker, Inc. 5201 Patrick Henry Drive Santa Clara, California 95054 FileMaker is a trademark of FileMaker, Inc. registered in the U.S. and other countries. The file folder logo is a trademark of FileMaker, Inc. All other trademarks are the property of their respective owners. FileMaker documentation is copyrighted. You are not authorized to make additional copies or distribute this documentation without written permission from FileMaker. You may use this documentation solely with a valid licensed copy of FileMaker software. All persons, companies, email addresses, and URLs listed in the examples are purely fictitious and any resemblance to existing persons, companies, email addresses, or URLs is purely coincidental. Credits are listed in the Acknowledgements documents provided with this software. Mention of third-party products and URLs is for informational purposes only and constitutes neither an endorsement nor a recommendation. FileMaker, Inc. assumes no responsibility with regard to the performance of these products. For more information, visit our website at www.filemaker.com. Edition: 01
Contents
Chapter 1 Introducing FileMaker Pro Advanced
About this guide Using the FileMaker Pro Advanced documentation Where to find PDF documentation Abiding by the license agreement for runtime solutions Your responsibilities as a developer 5 5 6 6 7
Index
1 Developer Utilities, for creating, customizing, and deploying runtime database solutions 1 Database Design Report feature, for publishing comprehensive documentation on structures or schemas
of databases
1 Script Debugger, for systematic testing and debugging of FileMaker scripts 1 Data Viewer, for monitoring fields, variables, and calculations 1 Copy feature, for copying fields or tables. You can also import table schema for use within the same file
or across different files.
1 Custom Menus feature, for creating customized menus for the solution 1 Custom Functions feature, for creating custom functions for use anywhere within the solution
1 FileMaker Pro Advanced Development Guide (this manual): describes how to use the features available
in FileMaker Pro Advanced
1 Installation and New Features Guide for FileMaker Pro and FileMaker Pro Advanced: contains
installation instructions and a list of the new features in the current version
1 FileMaker Pro Users Guide: contains key concepts and basic procedures 1 FileMaker Pro Tutorial: contains step-by-step lessons that teach you how to create and use
FileMaker Pro databases
1 FileMaker Pro Advanced Database Design Report XML Output Grammar manual: describes the
FileMaker Pro Advanced Database Design Report (DDR) XML output grammar for users who want to create tools that analyze or process the structure of databases
1 FileMaker Instant Web Publishing Guide: describes how to make FileMaker Pro and FileMaker Pro
Advanced databases accessible to web browser users over an intranet or the internet
1 FileMaker ODBC and JDBC Guide: describes how you can use FileMaker software as an ODBC client
application and as a data source for ODBC and JDBC applications.
1 in FileMaker Pro Advanced, choose Help menu > Product Documentation 1 visit www.filemaker.com/documentation for additional documentation
Most PDF manuals are located in the folder where you installed FileMaker Pro Advanced. If you installed FileMaker Pro Advanced in the default folder location, the PDF manuals are located here:
1 You must provide all of the end-user technical support. 1 You must provide an About layout that includes your name, address, and the telephone number for your
technical support. For more information about creating an About layout, see the next section.
1 You must read and agree to the terms and conditions of the FileMaker Pro Advanced license agreement,
available through the FileMaker Pro Advanced installer, before using the FileMaker Pro Advanced software.
Chapter 1
1 solution name 1 your company name and contact information 1 your support policy (for example, how and when you are available for technical support)
5. The About layout must contain this exact warning: USER WARNING: This database solution contains password(s) that can only be provided by the Developer identified above. For more information about creating an About layout, see Help. 6. If full access privileges have been permanently removed from your database solution by selecting the Remove admin access from files permanently option in the Developer Utilities, then the About layout must contain this exact warning: USER WARNING: This file is not customizable. Contact the above named Developer for information on customizing this database solution. The accounts and privileges protection in a FileMaker file should not be viewed as an absolute barrier that will prevent a customer from accessing files. FileMaker cannot guarantee that a customer will not be able to identify or bypass the password through third-party solutions or tools. Therefore, FileMaker recommends that you take appropriate steps to protect your consulting and development efforts without relying solely upon the password. For more information about accounts and privileges, see Help. If you have a dispute with your customer, you must resolve this dispute directly with the customer. FileMaker is unable to, and will not, attempt to resolve such disputes.
1 rename a set of database files and automatically update the internal links to related files and scripts 1 bind your database files into a stand-alone runtime database solution that does not require FileMaker Pro
or FileMaker Pro Advanced in order to be used on a computer
1 remove administrative access from all accounts and prevent users from modifying most design or
structural elements of your databases
1 display your database files in Kiosk mode 1 add the FileMaker Pro filename extension to your files
Note See FileMaker Pro Help for detailed, comprehensive information and step-by-step procedures about using FileMaker Pro Advanced.
10
1 If you want to create a copy of your database files with new names, click Create.
Note FileMaker Pro Advanced automatically updates internal links to related files and scripts.
1 If you want to further customize your database files or bind the files, under Solution Options, click
Specify. 11. In the Specify Solution Options dialog box, select one or more options:
To Do this
Bind databases to runtime applications Select Create Runtime solution application(s). Note This option can be combined with all others, except Databases must have a FileMaker file extension. See About creating runtime solutions on page 11. Permanently prohibit any Select Remove admin access from files permanently. administrative access to your solution Important Once removed, administrative access cannot be restored to the custom solution. For more information about removing Admin access to databases, see Help. Force accounts without full access privileges to open your solution in Kiosk mode Add the FileMaker extension to the filenames of database files Create a log file to record any errors encountered during processing Select Enable Kiosk mode for non-admin accounts. See Creating Kiosk solutions on page 17. Select Databases must have a FileMaker file extension. Note This option is not available if you select Create Runtime solution application(s). You can use this feature to add extensions to files that do not have extensions. Select Create Error log for any processing errors. Specify a location and a filename for the error log. Notes 1 If you don't specify a filename and location for the error log, it will be saved to the project folder with the filename Logfile.txt.
1 If an error occurs during the processing of the options, the error is logged in the error
log. An error message may also indicate that an error has been encountered.
12. Click OK. 13. To be able to quickly repeat the process, click Save Settings, and choose a folder and location for your settings file. For more information about saving solution settings, see Help. 14. Click Create.
Chapter 2
11
1 a primary database file that connects all of the auxiliary files 1 scripts and buttons to open and close auxiliary files, return to the primary file, display a splash screen
layout at startup, or quit a runtime application
1 1 1 1 1 1
common elements and a consistent appearance for cross-platform solutions tooltips and custom menus a custom layout theme used for every file in the solution an About layout to introduce your solution (required) a custom Help system that provides usage tips for your solution multiple privilege sets that can specify levels of access to layouts, menus, specific tables, record, fields, and so on
1 password-protected accounts assigned to privilege sets that determine the level of access of account users
For information about what users need in order to use your runtime database solution, see Distributing runtime solutions on page 13.
12
Once you have converted the files, you can upgrade them to take advantage of newer FileMaker Pro and FileMaker Pro Advanced features. If necessary, create scripts to import users existing data from the old runtime database solution into the new, upgraded solution. See Help for more information on importing data into upgraded runtime solutions. Use the Developer Utilities to bind the solution files into a new, upgraded runtime database solution. Distribute the new upgraded runtime database solution and provide instructions for how users can upgrade their files by converting the old files in the new runtime application and importing their data.
1 For Runtime Name, type a name. The name is used for the runtime application filename and for the
name of the folder that contains the runtime database solution files.
1 For Extension, type a three-character filename extension. The extension is used to associate the
solution files with the runtime applications. For more information about naming runtime solutions, see Help. 4. For Bindkey, type a key between 1 and 24 characters long. The binding key links the runtime application to the database files and ensures that the bound files will only open in the appropriate runtime application. The binding key is case-sensitive. For more information on setting the binding key, see Help. Important Binding installs system files pertaining to each platform. If your solution will be used in Windows, bind it using the Developer Utilities for Windows. If your solution will be used on Mac OS X, bind it using the Developer Utilities for Mac OS X. If youre creating a solution to be used on both Windows and the Mac OS X, create two separate runtime solutions by binding the original solution files twice: first using FileMaker Developer Utilities for Windows, and then using FileMaker Developer Utilities for Mac OS X. Use the same binding key on both platforms. 5. To add a company logo or other custom image to the closing splash screen, click Specify, select the closing image, and click Select. The image should be at least 32 x 175 pixels (72 dpi) or higher, otherwise it will be distorted when displayed. The supported image formats are JPEG and GIF. 6. For Delay, set the number of seconds that you want the splash screen to display. You can preview the effect that your custom splash screen will have by clicking the Preview button. 7. Once you have specified options, click OK. 8. To be able to quickly repeat the process, click Save Settings, and choose a folder and location for your settings file. For more information about saving and reusing Developer Utilities settings, see Help.
Chapter 2
13
9. Click Create. The Developer Utilities copy all of the runtime files to a new folder created inside the Project Folder and named after the runtime solution.
Important Your users should start your solution by double-clicking the runtime application icon, not the solution file icon. Double-clicking the icons for the solution or auxiliary files might result in errors, depending on whether there are other copies of the runtime application on their hard disk. If your users have more than one solution on their computers associated with the same three-character extension and they double-click the icon for the solution file, the first solution installed will attempt to open the file, and this might not be the correct application for the specific file.
14
Windows solution folder Runtime application Bound primary and auxiliary solution files DLLs generated during binding Extensions Dictionaries language resource folders
Mac OS X solution folder Runtime application package Bound primary and auxiliary solution files Extensions Dictionaries
Important These files and folders must not be renamed. For details on the contents of the Mac OS X runtime application package and the Windows Extensions folder and DLLs, see Help. If your runtime database solution requires custom files, you should provide the files with the runtime files. Plug-ins should be stored in the Extensions folder. If a developer uses a font not found on a users system, the runtime application will make a font substitution. If a font is included with the runtime, provision should be made for its installation through the installer program. See Using a custom installation program below. In addition to the runtime files, you will need to provide installation instructions for your users. For more information on documenting developer solutions, see Help.
Chapter 2
15
Using a compression utility program If your runtime database solution is not complex and you have confidence in the technical experience of your end users, you might consider a compression utility program rather than a custom installation program. Sharing solutions over a network Users cannot share your runtime database solution over a network unless they access the files using FileMaker Pro or FileMaker Pro Advanced installed on their machines. You must have a master password to enable or change network access to the file. For optimal performance, you can host the solution files using FileMaker Server. For information about the FileMaker Server and FileMaker Pro products, and information about volume license sales, visit the FileMaker website at www.filemaker.com. Recovering damaged files Power failures, hardware problems, or other factors can damage a FileMaker database file. If your database solution becomes damaged, your users will need to recover the damaged file. When the runtime application discovers a damaged file, a dialog box appears, telling the user to contact the developer. Even if the dialog box does not appear, files can become corrupted and exhibit erratic behavior. For information about recovering runtime files, see Help. Creating an About layout For runtime database solutions, the FileMaker Pro Advanced license specifies that you must create an About layout that provides information for your users on how to contact you for technical support. FileMaker uses the About layout to distinguish databases created by developers using FileMaker Pro Advanced rather than users of FileMaker Pro. For more information about what is required to appear in the About layout for runtime database solutions, see Your responsibilities as a developer on page 7. Creating a custom Help layout The FileMaker Pro Advanced Help system is not available in runtime applications. Create a Help layout that provides instructions for how to use your custom solution and add data to it. Then create a script in the primary file of your solution to display the Help system. Use the custom menus feature to make the script available as a command in the Help menu. To create a web page to document your solution, put a web viewer in your Help layout that opens the web page. To display your custom Help menu on Mac OS, you must start with an empty menu. For more information about creating and editing custom menus, see About custom menus on page 20.
16
1 Verify every function and option in your solution. If youre developing a solution for both platforms, test
it on both Windows and Mac OS X platforms.
1 Make sure your runtime database solution does not use a standard FileMaker Pro feature that is hidden
or disabled in the runtime application. See appendix A, Feature comparison of the runtime application with FileMaker Pro.
1 Verify that all scripts and buttons work as expected. This is especially important if youre displaying your
solution in Kiosk mode. See Creating Kiosk solutions on page 17.
1 Verify your installation procedures and test other instructions in the documentation. 1 Verify that your database layouts display well on monitors with different color capabilities and
resolutions and on the smallest size monitor your users may be using.
1 Test your runtime database solution with actual data. This is especially important if users are upgrading
from earlier versions of the runtime application and need to import data into new solution files.
1 Make sure all the auxiliary files and DLLs (Windows) are present. 1 Show your database solution to intended users to uncover any usability issues. 1 Install your bundled database files on a completely different computer to verify that all the files associated
with the primary file can be found.
1 If youre assigning passwords or permanently removing full access privileges, test all access levels. 1 Make sure your database solution contains an About layout that notifies users of the level of access
youre providing. Important You should keep an unbound version of any runtime database solution files, especially if youve permanently removed full access privileges.
Chapter 2
17
3. If necessary, create an Import script so users can import their existing data into the new primary file. For more information about importing data into upgraded runtime solutions, see Help. 4. Send your users a copy of the new primary file with instructions to replace the old primary file in the runtime database solution folder. To distribute a new or updated auxiliary file: 1. In FileMaker Pro Advanced, create the new auxiliary file or open the original auxiliary file (before it was bound) and make changes as required. 2. If necessary, create an Import script so users can import their existing data into the new file. For more information about importing data into upgraded runtime solutions, see Help. 3. Use the Developer Utilities to rebind all of the files in the runtime database solution and include the new or updated auxiliary file. Use the same binding key that you used for the primary file. 4. Send your users a copy of the new or updated auxiliary file along with instructions to place it in the runtime database solution folder, replacing the old file if appropriate. As long as the binding key has not changed, you dont need to redistribute the runtime application or other solution files.
1 create an account with a limited privilege set or create a specific Kiosk account. 1 enable Kiosk mode. At the same time that you enable Kiosk mode, you can bind the database as a runtime
solution.
1 clear the default option of logging into the file with the Admin account.
To create a Kiosk account: 1. Ensure you have a limited access account. 2. With the database solution open, choose File menu > Manage > Accounts & Privileges. 3. In the Manage Accounts & Privileges dialog box, click New. 4. In the Edit Account dialog box, type an account name, click Active for the Account Status, and select New Privilege Set from the Privilege Set list.
18
5. In the Edit Privilege Set dialog box, give the privilege set a name and description. 6. For Layouts, Value Lists, and Scripts, select either All view only or All no access. 7. Clear the Manage extended privileges checkbox. 8. Select other options as required and click OK. To enable Kiosk mode: 1. Follow the procedures in Using the Developer Utilities on page 9. 2. In the Specify Solution Options dialog box, select Enable Kiosk mode for non-admin accounts. 3. Select other options as required click OK. 4. To be able to quickly repeat the process, click Save Settings, and choose a folder and location for your settings file. For information on saving solution settings, see Help. 5. Click Create. If you did not bind the files to a runtime application, the Developer Utilities copy the selected database files to the Project Folder. If you did bind the files to a runtime application, the Developer Utilities copy all of the runtime files to a new folder created inside the Project Folder and named after the runtime solution. To change the default option of logging into the file with the Admin account: 1. With the database solution open, choose File menu > File Options. 2. On the Open/Close tab, clear Log in using. 3. Click OK. When you create a solution to run in Kiosk mode, you need to provide navigation for your solution and the ability for users to quit your solution. Note If you have a previous Kiosk solution that displayed the status area, you will need to update your solution. You cannot display the status toolbar or layout bar in a Kiosk solution. You will need to add record navigation, script paused status, and script Cancel and Continue buttons to your layouts. For more information on using scripts and buttons to control Kiosk solutions, see Help.
1 1 1 1 1
copy and paste fields for use within the same file or other database files copy or import existing tables into your database file create custom functions for use anywhere within a file create custom menus create custom layout themes
Important You must have full access privileges to customize database solutions. Note See Help for detailed, comprehensive information and step-by-step procedures about using FileMaker Pro Advanced.
1 Copy table schemas Open source files to select and copy the tables you want. Then, paste the table
schemas into the destination file.
1 Import table schemas Import table schemas directly into the destination file. You can import just the
schemas or import data with a single schema. (To import the data with a single schema, choose File menu > Import Records > File.)
To Copy a field schema Copy a table schema Import a table schema Do this Choose File menu > Manage > Database > Fields tab. Select the field from the list, then click Copy. Data is not copied. Open the file that contains the table you want to copy. Choose File menu > Manage > Database > Tables tab. Select the table from the list, then click Copy. Open the file into which you want to import a table. Choose File menu > Manage > Database > Tables tab. Click Import. Select the source file and table, and click OK.
For more information about copying or importing fields and tables, see Help.
20
Parameters list
Function list
Formula box
Your custom parameters appear in this space Edit Custom Function dialog box
3. In the Edit Custom Function dialog box, type a name for the function and build a formula. 4. Click OK. For more information about creating custom functions, see Help.
1 create a menu or edit an existing menu 1 duplicate or delete a menu 1 add, duplicate, or delete menu items 1 specify menu item properties, such as display title, shortcut, and action.
Chapter 3
21
Submenu Menu
1 editing a copy of a standard FileMaker menu. Use this method to make minor changes to existing menus,
for example, to modify the properties of a few menu items.
1 starting with an empty menu. Use this method to make significant changes to menus, for example, to add
menus and change menu item properties.
1 Select Item Name and type New Invoice. 1 Select Action and specify the My New Invoice script.
4. Click OK.
22
The custom menu item is used in Custom Menu Set 1 by default. To see the custom menu item in FileMaker Pro: 1. For Default menu set for this file, select Custom Menu Set 1, then click OK to close the Manage Custom Menus dialog box. 2. Choose the Records menu. The New Invoice menu item appears at the top of the Records menu.
2. Click Create. 3. In the Create Custom Menu dialog box, do one of the following, then click OK:
1 Click Start with an empty menu. 1 Click Start with a standard FileMaker menu, then select a menu from the list.
The Edit Custom Menu dialog box appears. 4. In the Edit Custom Menu dialog box, specify a custom menu name, a comment that describes the menu (optional), the menu title that you want to display in the menu bar, and the operating system platform and FileMaker Pro modes in which the menu is to appear. See Help for more information on these options. Note The comment appears in the Manage Custom Menus dialog box, not in your solution file. 5. Create custom menu items, as described in the following section.
Chapter 3
23
Add a submenu
Drag an arrow
24
To change the properties of a menu item: 1. Select a menu item from the Menu Items list and do one or more of the following:
To Change a command for a menu item Change a menu item from one type to another Do this For Based on an existing command, click Specify, choose a different command, then click Select. For Menu Item Type, choose a different type. (For example, you can change a separator to a command.)
Change the name of a menu Select Item Name and enter a new name. item To base the menu title on the result of a calculation, click Specify, then build a formula in the Specify Calculation dialog box. Windows: To specify an access key, type an ampersand (&) before the character you want to use as the access key. For example, type &Open to display the Open menu item with the letter O as the access key. Define a keyboard shortcut for a menu item Perform a script or script step when a user selects a menu item Select Keyboard Shortcut. In the Specify Shortcut dialog box, type a key combination, then click OK. Keyboard shortcuts appear next to menu items in the Menu Items list. For more information about keyboard shortcuts, see Help. Select Action. In the Specify Script Step dialog box, select a step and specify options as necessary, then click OK. Note To affect the behavior of a currently running script (for example, to halt, exit, resume, or pause the script) use the Perform Script script step. For more information about scripts and script steps, see Help.
Change a script or script step For Action, click Specify, modify the script definition, then click OK. Choose a platform for a menu item Select Windows or Macintosh or both. Your menu item will appear in FileMaker Pro files running in the platforms you specify. Note Some commands are valid on only one platform.
2. Click OK.
1 specify menu sets for individual layouts 1 create scripts that change menu sets 1 change the default menu set in a solution files menu bar 1 switch menu sets temporarily using the FileMaker Pro Advanced Tools menu
Chapter 3
25
To create or edit menu sets: 1. Choose File menu > Manage > Custom Menus > Custom Menu Sets tab. 2. Click Create. 3. In the Edit Custom menu set dialog box, click Add to specify which menus to include in the menu set.
To: Add a menu to this menu set Do this: Click Add, do one of the following in the Select Menu dialog box, then click Select: 1 Choose a menu from the list.
4. Click OK to return to the Manage Custom Menus dialog box. Tip To change the default menu set for this file, select Default menu set for this file and click OK. You see the new menu set in FileMaker Pro. For more information about creating, installing, and testing custom menu sets, see Help.
26
Text in header part Fill color and pattern for body part
Fill color and pattern for footer part Create themes to automatically apply different styles to text and background fills in layout parts, fields, and field labels
To create or modify a theme: 1. Make a copy of one of the theme files in the Themes folder. Windows: FileMaker Pro Advanced\Extensions\English\Themes\ or Mac OS X: FileMaker Pro Advanced/FileMaker Pro Advanced.app/Contents/Resources/English.lproj/ Themes/ Important The total number of theme files is limited to 50. 2. Rename the copy and include the .fth extension with the new filename. Keep the new file in the Themes folder. In order for the New Layout/Report assistant to display a theme option, the theme file must reside in the Themes folder and it must have the .fth filename extension. 3. Open the theme file in a text editor.
Single-line element
Multi-line element
Attributes
Chapter 3
27
4. Change the name of a theme by replacing the value of the THEMENAME element with a new name.
<THEMENAME VALUE="Purple and White Screen" />
Important If your THEMENAME value contains any upper-ASCII characters, use the HINT attribute to ensure that the theme name will appear on both the Windows and Mac OS X platforms. 5. Change the values of other elements and attributes. For example, to change the background fill color of the body part in a layout to a light purple, change the color hexadecimal (hex) value to #9933CC:
<BODYPART> <FILL COLOR = #9933CC PATTERN = 2 />
6. Remove any elements that you dont want to specify. Be sure to remove the entire single-line or multi-line element including its start and end tags. 7. Scroll down to the next FMTHEME element and repeat these steps to change the THEMENAME value and other elements. 8. Save the file in text format with the filename extension .fth in the Themes folder. Each new THEMENAME value will appear in the New Layout/Report assistant as a Layout Theme option. 9. In FileMaker Pro Advanced, choose Layouts menu > New Layout/Report to use your theme. Follow the instruction in the New Layout/Report assistant. Names of custom themes appear as options. The third panel presents you with a list of themes to select from. If your new themes dont appear in the New Layout/Report assistant, you might have made a syntax error.
28
1 the Script Debugger for systematic testing and debugging of FileMaker scripts 1 the Disable script step feature for testing portions of a script 1 the Database Design Report feature for publishing comprehensive documentation on database schema
and options
Debugging scripts
With FileMaker Pro Advanced, you can use the Script Debugger to:
1 1 1 1 1 1 1 1 1 1
debug scripts that are run from the Scripts menu or keyboard shortcuts debug startup scripts (the Script Debugger menu is enabled even if there are no open files) debug a script activated by a script trigger, button, or custom menu step through scripts one step at a time view and track sub-scripts monitor fields, variables, and calculations disable script steps debug restricted-access scripts pause a script when script errors are encountered click a script error number to open a Help topic
To run scripts in debug mode: 1. Select Tools menu > Script Debugger. The Script Debugger dialog box opens. 2. Run your script.
30
You can view sub-scripts when you step through scripts in the Script Debugger. For example, if Script A calls Script B, which then calls Script C, you can view the steps in all three scripts. The Script Debugger recognizes the privileges attached to each script. A script will only appear in the Script Debugger if you have editing privileges for the script and the access privileges for the script are set to to log in and edit script steps in restrictedModifiable. You can click Authenticate/Deauthenticate script access scripts. In the Script Debugger window you can select more than one step from the step list, enabling you to place simultaneous multiple breakpoints on steps. If multiple steps are selected, the Set Next Step button will be disabled. Notes
1 You cant set breakpoints on script steps called by buttons or custom menus. 1 When you use the Script Debugger to step through scripts activated by a script trigger, you will not be
able to interact with the document windows, move between fields or records, change the data, close the window, or quit. This blocking of interaction only occurs when a script is triggered via some action. When you are debugging a script that is not activated by a script trigger you can interact normally with the document windows, fields, and records. For more information about using script triggers, see Help. Tip To enable the Script Debugger from the Manage Scripts dialog box, press Shift and click the Perform button. To disable the Script Debugger, press Ctrl (Windows) or Command (Mac OS) and click the Perform button.
Chapter 4
31
2. In the Manage Scripts dialog box, double-click the script name. Or, click the Edit button in the Script Debugger dialog box.
3. In the Edit Script dialog box, select one or more script steps, then click Disable or Enable. For more information about debugging scripts, see Help.
2. In the Current tab, double-click a value to display a dialog box where you can:
1 View, edit, and copy local or global variables. 1 View (but not edit) field values.
3. To sort expressions, click a column heading. Expressions sort independently in this order: fields, global variables, local variables. 4. To add an expression to the Watch tab, click Add to Watch. The expression is copied to the Watch tab, and the Watch tab opens. 5. To view restricted-access expressions, click , then log into an account that has full access privileges.
Note If you logged in to edit restricted-access scripts in the Script Debugger, your access privileges also apply to the Data Viewer. If you logged in from the Data Viewer, your access privileges also apply to the Script Debugger. In either case, your editing privileges last until you close the Script Debugger or the Data Viewer.
32
.
or double-click the expression.
Select one or more expressions, then click Select one or more expressions, then click
. .
8. In the Edit Expression dialog box, select the database file containing the expression, then build or edit the expression you want to monitor.
Select mathematical and text operators Select comparison and logical operators Choose the way functions are listed in the dialog box
Select functions
Formula box
Results of the expression Evaluate the contents of the expression Add the expression to the Data Viewer
9. Click Evaluate Now to display the results of an expression, or click Monitor to add the expression to the watch list in the Data Viewer. 10. In the Data Viewer, click Refresh Values to refresh the calculations in the list. For more information about using the Data Viewer, see Help.
Chapter 4
33
1 examine a textual representation of your database schema 1 gather statistics on the structure of your database 1 use the information in the report to recreate the structure of your database if you lose the original database
files
34
36
Installing plug-ins
Some plug-ins (and the libraries they reference) load only when the process is executed by a user who is logged into the system; FileMaker Server executes as a service, not as a user process. Consequently, you need to write plug-ins differently to work with FileMaker Server. Users will need to see their operating system documentation to find which libraries are typically available. For information on installing web publishing plug-ins, see FileMaker Server Help. To install a plug-in, drag the plug-in file into the FileMaker users Extensions folder as follows:
On this operating system:
In Windows, the plug-in extension must be .fmx. In Mac OS X, the plug-in extension must be .fmplugin.
Enabling plug-ins
To enable a plug-in: 1. Open the Preferences dialog box. Windows: Choose Edit menu > Preferences. Mac OS X: Choose FileMaker Pro Advanced application menu > Preferences. 2. Click the Plug-Ins tab. 3. Select the plug-in in the list. A plug-in will appear in the list if its installed in the correct FileMaker folder. When starting, FileMaker Pro first loads the plug-ins stored in the current users FileMaker Extensions folder. If a particular plug-in is not found in that folder, FileMaker Pro searches for that plug-in in the Extensions folder for the FileMaker Pro application.
Chapter 5
37
Configuring plug-ins
To configure a plug-in: 1. Select the plug-in in the Preferences dialog box. 2. Click Configure. The Configure button is only available when the sixth character in the option string of the selected plugin is Y. 3. Follow instructions in the configuration dialog box to configure the plug-in. 4. Click OK.
38
1 All the database design features have been removed or hidden in the runtime application.
This includes Layout mode and commands on the Manage submenu.
1 Custom functions and custom menus created with FileMaker Pro Advanced will work in the runtime
application, although users of the runtime application cannot modify or create new custom functions or custom menus.
1 Some other menu commands have been removed from the runtime application.
For example, you cant use the runtime application to create, open, or close a database. (Bound runtime database files must contain a custom button or script to close or open other files. There is no close command on a runtime database window.)
1 FileMaker Pro Help is not available in the runtime application. However, you can use the custom menu
feature to display customized Help text that you create.
1 External function plug-ins can be enabled in the Preferences dialog box. 1 Although the XML Data filter appears as an option for the Convert File script step, you cant convert
XML files using this script step in a runtime application.
1 FileMaker Pro File Sharing, serving a database on the web, or communicating with a Java applet requires
FileMaker Pro or FileMaker Pro Advanced. You can, however, use a compatible version of FileMaker Server to serve runtime solution files.
1 Apple events are supported but OLE automation is not supported in the runtime application on Windows
machines.
1 Runtime applications cannot be shared over a network. 1 Runtime applications do not include the ability to Save/Send Records as Adobe PDF files. 1 FileMaker Pro Advanced features are not available in the runtime application.
A runtime database can, however, be opened in either FileMaker Pro or FileMaker Pro Advanced. The full functionality of these applications will be enabled, except if full access privileges have been removed.
1 Runtime applications dont support external SQL data sources (ESS), ODBC import, or the Execute SQL
script step.
40
The Layout tab is changed to the Color tab in the Preferences dialog box for the runtime application.
General preferences in a runtime application (Windows)
The File Options dialog box in the runtime application displays only the Spelling tab.
File options dialog box in a runtime application
Appendix A
41
Mac OS X Pro
RT
1 1 1 1 1 1 1 1 1 1 1 1 1 1 1 1 1 1 1 1 1 1 1
1 1 1 1 1 1 1 1 1 1 1 1 1 1 1
1 2
1 1 1 1 1 1
1 2
1 1 1 1 1 1 1
1
3
1
4
Note You can add menu items that mimic Open, Close, and Recover menu commands to a runtime application using custom menus based on a script or script step. For more information, see Creating custom menus on page 22.
42
Windows Edit Menu command Undo/Cant Undo Redo/Cant Redo Cut Copy Paste Paste Special Clear Duplicate Select All Find/Replace Spelling Object Export Field Contents Preferences
Pro RT
Mac OS X
Pro RT
1 1 1 1 1 1 1 1 1 1 1 1 1 1
Windows
1 1 1 1 1 1 1 1 1 1 1 1 1
1 1 1 1 1 1 1 1 1 1 1
1 1 1 1 1 1 1 1 1 1
Mac OS X
RT Pro RT
View Menu command Browse Mode Find Mode Layout Mode Preview Mode Go to Layout View as Form View as List View as Table Status Toolbar Customize Status Toolbar Formatting Bar Text Ruler Zoom In Zoom Out
Pro
1 1 1 1 1 1 1 1 1 1 1 1 1 1
1 1 1 1 1 1 1 1 1 1 1 1 1
1 1 1 1 1 1 1 1 1 1 1 1 1 1
1 1 1 1 1 1 1 1 1 1 1 1 1
Appendix A
43
Windows Insert Menu command Picture QuickTime Sound File Object Current Date Current Time Current User Name From Index From Last Visited Record
Pro RT
Mac OS X
Pro RT
1 1 1 1 1 1 1 1 1 1
Windows
1 1 1 1 1 1 1 1 1 1
1 1 1 1 1 1 1 1 1
Mac OS X
1 1 1 1 1 1 1 1 1
Format Menu command Font Size Style Align Text Line Spacing Text Color
Pro
RT
Pro
RT
1 1 1 1 1 1
1 1 1 1 1 1
1 1 1 1 1 1
1 1 1 1 1 1
Windows Records Menu command New Record Duplicate Record Delete Record Delete Found Records/Delete All Records Go to Record Refresh Window Show All Records Show Omitted Only Omit Record Omit Multiple Modify Last Find
Pro RT
Mac OS X
Pro RT
1 1 1 1 1 1 1 1 1 1 1
1 1 1 1 1 1 1 1 1 1 1
1 1 1 1 1 1 1 1 1 1 1
1 1 1 1 1 1 1 1 1 1 1
44
Windows Records Menu command Saved Finds Sort Records Unsort Replace Field Contents Relookup Field Contents Revert Record
Pro RT
Mac OS X
Pro RT
1 1 1 1 1 1
1 1 1 1 1 1
1 1 1 1 1 1
1 1 1 1 1 1
Requests Menu command (Find mode) Add New Request Duplicate Request Delete Request Go to Request Show All Records Perform Find Constrain Found Set Extend Found Set Revert Request
Windows
Pro RT
Mac OS X
Pro RT
1 1 1 1 1 1 1 1 1
1 1 1 1 1 1 1 1 1
1 1 1 1 1 1 1 1 1
1 1 1 1 1 1 1 1 1
Windows Scripts Menu command Manage Scripts Save Script Save All Scripts Revert Script <Script names>
Pro RT
Mac OS X
Pro RT
1 1 1 1 1 1
1 1 1 1 1 1
Note The Save Script, Save All Scripts, and Revert Script menu commands only appear when the Manage Scripts or Edit Script dialog box is active.
Appendix A
45
Windows Window Menu command New Window Show Window Hide Window Minimize Window Tile Horizontally Tile Vertically Cascade Windows Arrange Icons Bring All To Front <Names of open files>
Pro RT
Mac OS X
Pro RT
1 1 1 1 1 1 1 1 1
1 1 1 1 1 1 1 1
1 1 1 1 1 1 1 1
1 1 1 1 1 1 1 1 1
Windows Help Menu command FileMaker Pro Help Keyboard Shortcuts Quick Start Screen Resource Center Product Documentation Consultants and Solutions Provide FileMaker Feedback Check for Updates Register FileMaker Pro FileMaker Forum Service and Support About FileMaker Pro (or About FileMaker Pro Advanced) About FileMaker Pro Runtime (Displays if no custom About script is specified) About <runtime solution> (Displays if custom About script is specified) <Runtime solution Help script name> (Displays if custom Help script is specified)
1
Mac OS X
RT Pro RT
Pro
1 1 1 1 1 1 1 1 1 1 1 1 1 1 1
1 1 1 1 1 1 1 1 1 1 1
1 1
46
Application Menu command (Mac OS X only) About FileMaker Pro About FileMaker Pro Runtime (Displays if no custom About script is specified) About <runtime solution> (Displays if custom About script is specified) Preferences Services Hide FileMaker Pro Hide <runtime solution> Hide Others Show All Quit FileMaker Pro Quit <runtime solution>
Pro
RT
1 1 1 1 1 1 1 1 1 1 1 1 1 1 1
1 1 1 1 1 1 1 1 1 1 1 1 1 1
Open Manage Database Open Manage Value List Open Manage Data Sources Open Manage Scripts Open Manage Layouts Open Sharing Open Help Set Multi-User New File Open File Options (partially available; Spell checking tab will open) Open Remote Execute SQL Save Records As PDF Save Records As Snapshot Link
Note Open File returns an error if the specified file has not been bound to the runtime application. A runtime solution can only perform an external script if the external file is bound to the runtime solution.
Appendix A
47
Note The filename extension for the runtime database files is registered at HKEY_CLASSES_ROOT. Mac OS X preferences FileMaker Pro stores its preferences settings in
com.filemaker.client.pro.plist
48
Index
A
About layout described 6 required contents of 7 access privileges 7, 19 accounts and privileges 7, 19 for Kiosk mode 17 removing Admin access 10 Admin access removing from files 10 removing from Kiosk solutions 18 Apple events in runtime applications 39 attributes in layout themes 25 authenticating scripts 30 auxiliary files problems with double-clicking icons 13 updating 17
D
data sources updating 16 updating automatically 10 Data Viewer 31 Database Design Reports 33 database schemas copying or importing 19 in Database Design Report 33 database statistics 33 database structure, recreating 33 DDR. See Database Design Reports debugging scripts 29 delay, splash screen 12 Developer Utilities about 9 creating runtime solutions 11 disabling script steps 30 distributing runtime database solutions about 13 distributing updates 16 terms and conditions 6 documenting Database Design Reports 33 runtime solutions 15 Dynamic Link Libraries (DLLs) 13
B
backups 16 binding key about 12 updating runtime database solutions 16 binding runtime solutions 12
C
C/C++ 35 calculations advanced 31 using external functions 35 colors, layout themes 26 commands, menu available in runtime applications 41 compression utilities for runtime databases 15 configuring plug-ins 37 converting files from previous versions 11 copying field or table schemas 19 cross-platform solutions 12 custom functions, creating 20 custom menus about 20 creating 22 example 21 menu items 23 menu sets 24
E
Edit menu commands available in runtime applications 42 electronic documentation 6 elements in layout themes 27 error codes, viewing from Script Debugger 29 error log 10 Execute SQL script step 46 expressions, monitoring 31 Extensible Markup Language (XML). See XML Extensions folder, location of plug-ins 36 extensions, filename. See filename extensions external function plug-ins described 35 enabling 36 in runtime applications 39 external functions 35
50
F
fields copying schema 19 monitoring 31 File menu commands available in runtime applications 41 File Options available in runtime application 40 file references. See data sources FileMaker Developer. See FileMaker Pro Advanced FileMaker Pro Advanced documentation 5 license agreement 6 upgrading from earlier versions 11 FileMaker Pro, menus available 41 FileMaker Server 15, 35, 39 filename extensions for database files 10 for runtime solutions 12 layout themes 26 plug-ins 36 files compressing runtime 15 converting 11 removing Admin access 10 renaming 9 updating 10 fmplugin filename extension 36 fmx filename extension 36 folder structure, solution 13 fonts layout themes 25 not on users system 14 Format menu commands available in runtime applications 43 formulas for custom functions 20 monitoring 31 fth filename extension 26 functions custom 20 external 35 monitoring in formulas 32
I
icons for runtime solutions 13 Insert menu commands available in runtime applications 43 installation instructions 6 installers for runtime databases 14 InstallShield 14 Internet databases on 6 runtime applications on 39
J
JDBC, FileMaker as data source 6
K
keyboard shortcuts in custom menu items 24 Kiosk solutions, creating 17
L
Layout mode commands, unavailable in runtime applications 39 layout themes, creating 25 legal requirements 6 license agreement 6 Logfile.txt 10 logo, adding to runtime solution 12
M
Mac OS X runtime application package 14 stored preferences 47 MacInstallerBuilder 14 Manage Scripts 30 Manage submenu, unavailable in runtime applications 39 menu commands, available in runtime applications 41 menu separators 23 menu sets, creating 24 messages, error log 10 Microsoft Windows, stored registry settings 47 MindVision Installer VISE 14 multiple tables per database file 11
H
Help menu commands available in runtime applications 45 Help layout 15 HTML format for Database Design Reports 33
N
naming runtime database solutions 12 networks, sharing solutions on 15 new features 6 New File script step 46 New Layout/Report assistant 25, 27
Index
51
O
ODBC, FileMaker as data source 6 OLE automation in runtime applications 39 Open File Options script step 46 Open File script step 46 Open Help script step 46 Open Manage Data Sources script step 46 Open Manage Database script step 46 Open Manage Layouts script step 46 Open Manage Scripts script step 46 Open Manage Value List script step 46 Open Remote script step 46 Open Sharing script step 46 opening files in runtime applications 39
runtime database solutions About layout requirements 7, 15 binding files 12 converting 11 creating 9, 11 documenting 13 preparing files 11 recovering damaged files 15 starting 13 updating 16 upgrading 11
S
Save Records as PDF script step 46 Save Records as Snapshot Link script step 46 schemas, database copying or importing 19 documenting 33 Script Debugger described 29 with script triggers 30 script triggers, debugging 30 scripts authenticating 30 debugging 29 disabling script steps 30 steps ignored by runtime applications 46 unlocking 30 Scripts menu commands available in runtime applications 44 separators, menu item 23 Set Multi-User script step 46 settings file 10 shortcuts, keyboard. See keyboard shortcuts solution file icon 13 problems with double-clicking icon 13 splash screen in runtime solutions closing 12 startup 11 starting runtime solutions 13 statistics, database 33 structure, database 33
P
passwords, required warning in About layout 7 patterns, layout themes 26 PDF documentation 6 plug-ins configuring 37 in runtime applications 39 installing 36 preparing 35 preferences available in runtime application 40 primary file connecting auxiliary files 11 specifying 9 updating 16 Project Folder 9, 13
R
Records menu commands available in runtime applications 43 recovering damaged runtime files 15 registry, stored settings 47 renaming files 9 reports, database 33 Requests menu commands available in runtime applications 44 runtime applications available menu commands 41 compared to FileMaker Pro 39 enabling plug-ins in 39 icon 13 ignored script steps 46 stored Mac OS X preferences 47 stored Windows registry settings 47
52
T
tables, database copying or importing schema 19 excluding from Database Design Report 33 multiple per file 11 testing database solutions 16 scripts 29 text editors 25 themes. See layout themes touch screen 17 troubleshooting calculations 31 fields 31 Script Debugger 29 using Database Design Reports 33 variables 31 tutorial, FileMaker Pro 6
V
variables, monitoring 31 View menu commands available in runtime applications 42
W
web browser users 6 web viewer 15 Window menu commands available in runtime applications 45 Windows runtime application package 14
X
XML documents for layout themes 25 editors 25 format for Database Design Reports 33 output grammar for DDR 6 XML 1.0 specification 27 XML-document processing instruction 27
U
unlocking scripts 30 updates plug-ins 35 to runtime solutions 16