Filemaker Script Steps Reference File Maker Pro 14 Fmp14 Scripts En

User Manual: filemaker FileMaker Pro 14 - Script Steps Reference Free User Guide for FileMaker Software, Manual

Open the PDF directly: View PDF .
Page Count: 305

Download
Open PDF In Browser	View PDF

FileMaker Pro 14
®

Script Steps Reference

© 2007–2015 FileMaker, Inc. All Rights Reserved.
FileMaker, Inc. 
5201 Patrick Henry Drive
Santa Clara, California 95054
FileMaker and FileMaker Go are trademarks of FileMaker, Inc. registered in the U.S. and other countries. The file folder logo
and FileMaker WebDirect are trademarks 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 http://www.filemaker.com.
Edition: 01

Contents

Contents
Script steps reference (alphabetical list)

7

About script steps
Creating scripts to automate tasks
Using this script steps reference
Learning about scripts

11
11
11
11

Control script steps
Perform Script
Perform Script On Server
Pause/Resume Script
Exit Script
Halt Script
If
Else If
Else
End If
Loop
Exit Loop If
End Loop
Allow User Abort
Set Error Capture
Set Variable
Set Layout Object Animation
Install OnTimer Script

12
13
15
17
19
21
23
25
26
27
28
30
31
32
33
35
37
38

Navigation script steps
Go to Layout
Go to Record/Request/Page
Go to Related Record
Go to Portal Row
Go to Object
Go to Field
Go to Next Field
Go to Previous Field
Close Popover
Enter Browse Mode
Enter Find Mode
Enter Preview Mode

40
41
43
45
48
50
52
54
55
56
57
58
59

Editing script steps
Undo/Redo
Cut
Copy
Paste
Clear
Set Selection
Select All
Perform Find/Replace

60
61
62
64
66
67
68
70
71

FILEMAKER PRO SCRIPT STEPS REFERENCE

3

Contents

Fields script steps
Set Field
Set Field By Name
Set Next Serial Value
Insert Text
Insert Calculated Result
Insert From Device
Insert From Index
Insert From Last Visited
Insert From URL
Insert Current Date
Insert Current Time
Insert Current User Name
Insert Picture
Insert Audio/Video
Insert PDF
Insert File
Replace Field Contents
Relookup Field Contents
Export Field Contents

73
74
76
78
80
82
83
86
88
90
92
93
94
95
97
99
101
103
105
107

Records script steps
New Record/Request
Duplicate Record/Request
Delete Record/Request
Delete Portal Row
Delete All Records
Open Record/Request
Revert Record/Request
Commit Records/Requests
Copy Record/Request
Copy All Records/Requests
Import Records
Export Records
Save Records As Excel
Save Records As PDF
Save Records As Snapshot Link

109
110
111
112
114
116
117
119
120
122
123
125
129
132
134
136

Found Sets script steps
Perform Find
Perform Quick Find
Constrain Found Set
Extend Found Set
Modify Last Find
Show All Records
Show Omitted Only
Omit Record
Omit Multiple Records
Sort Records
Sort Records by Field
Unsort Records
Find Matching Records

138
139
141
143
144
145
147
148
150
151
152
154
156
157

FILEMAKER PRO SCRIPT STEPS REFERENCE

4

Contents

Windows script steps
New Window
Select Window
Close Window
Adjust Window
Move/Resize Window
Arrange All Windows
Freeze Window
Refresh Window
Scroll Window
Show/Hide Menubar
Show/Hide Toolbars
Show/Hide Text Ruler
Set Allowed Orientations
Set Window Title
Set Zoom Level
View As

159
160
162
164
166
167
169
171
173
175
176
177
178
179
180
181
182

Files script steps
New File
Open File
Close File
Convert File
Set Multi-User
Set Use System Formats
Save a Copy as
Recover File
Print Setup
Print

184
185
186
188
189
191
193
194
196
197
198

Accounts script steps
Add Account
Delete Account
Reset Account Password
Change Password
Enable Account
Re-Login

200
201
203
205
207
209
211

Spelling script steps
Check Selection
Check Record
Check Found Set
Correct Word
Spelling Options
Select Dictionaries
Edit User Dictionary

213
214
215
216
217
218
219
220

Open Menu Item script steps
Open Edit Saved Finds
Open Preferences
Open File Options
Open Manage Containers
Open Manage Database

221
222
223
224
225
226

FILEMAKER PRO SCRIPT STEPS REFERENCE

5

Contents

Open Manage Data Sources
Open Manage Layouts
Open Script Workspace
Open Manage Themes
Open Manage Value Lists
Open Find/Replace
Open Help
Open Remote
Open Sharing
Upload To FileMaker Server

227
228
229
230
231
232
233
234
235
236

Miscellaneous script steps
Get Directory
Show Custom Dialog
Allow Formatting Bar
Refresh Object
Beep
Speak (OS X)
Dial Phone
Install Plug-In File
Install Menu Set
Set Web Viewer
Open URL
Send Mail
AVPlayer Play
AVPlayer Set Playback State
AVPlayer Set Options
Refresh Portal
Send DDE Execute (Windows)
Perform AppleScript (OS X)
Execute SQL
Send Event
Comment
Flush Cache to Disk
Exit Application
Enable Touch Keyboard

237
238
240
243
244
245
246
248
250
252
253
255
257
260
262
263
265
266
268
270
272
275
277
278
279

Glossary

280

FILEMAKER PRO SCRIPT STEPS REFERENCE

6

Script steps reference (alphabetical list)

Script steps reference (alphabetical list)
Add Account
Adjust Window
Allow Formatting Bar
Allow User Abort
Arrange All Windows
AVPlayer Play
AVPlayer Set Options
AVPlayer Set Playback State
Beep
Change Password
Check Found Set
Check Record
Check Selection
Clear
Close File
Close Popover
Close Window
Comment
Commit Records/Requests
Constrain Found Set
Convert File
Copy
Copy All Records/Requests
Copy Record/Request
Correct Word
Cut
Delete Account
Delete All Records
Delete Portal Row
Delete Record/Request
Dial Phone
Duplicate Record/Request
Edit User Dictionary
Else
Else If
Enable Account
Enable Touch Keyboard
End If
End Loop
Enter Browse Mode
Enter Find Mode
Enter Preview Mode
Execute SQL
Exit Application
Exit Loop If
Exit Script
Export Field Contents
Export Records
Extend Found Set

FILEMAKER PRO SCRIPT STEPS REFERENCE

201
166
243
32
169
260
263
262
245
207
216
215
214
67
188
56
164
275
120
143
189
64
123
122
217
62
203
116
114
112
248
111
220
26
25
209
279
27
31
57
58
59
270
278
30
19
107
129
144

7

Script steps reference (alphabetical list)

Find Matching Records
Flush Cache to Disk
Freeze Window
Get Directory
Go to Field
Go to Layout
Go to Next Field
Go to Object
Go to Portal Row
Go to Previous Field
Go to Record/Request/Page
Go to Related Record
Halt Script
If
Import Records
Insert Audio/Video
Insert Calculated Result
Insert Current Date
Insert Current Time
Insert Current User Name
Insert File
Insert From Device
Insert From Index
Insert From Last Visited
Insert From URL
Insert PDF
Insert Picture
Insert Text
Install Menu Set
Install OnTimer Script
Install Plug-In File
Loop
Modify Last Find
Move/Resize Window
New File
New Record/Request
New Window
Omit Multiple Records
Omit Record
Open Edit Saved Finds
Open File
Open File Options
Open Find/Replace
Open Help
Open Manage Containers
Open Manage Data Sources
Open Manage Database
Open Manage Layouts
Open Manage Themes
Open Manage Value Lists
Open Preferences
Open Record/Request
Open Remote
Open Script Workspace

FILEMAKER PRO SCRIPT STEPS REFERENCE

157
277
171
238
52
41
54
50
48
55
43
45
21
23
125
97
82
92
93
94
101
83
86
88
90
99
95
80
252
38
250
28
145
167
185
110
160
151
150
222
186
224
232
233
225
227
226
228
230
231
223
117
234
229

8

Script steps reference (alphabetical list)

Open Sharing
Open URL
Paste
Pause/Resume Script
Perform AppleScript (OS X)
Perform Find
Perform Find/Replace
Perform Quick Find
Perform Script
Perform Script On Server
Print
Print Setup
Recover File
Refresh Object
Refresh Portal
Refresh Window
Re-Login
Relookup Field Contents
Replace Field Contents
Reset Account Password
Revert Record/Request
Save a Copy as
Save Records As Excel
Save Records As PDF
Save Records As Snapshot Link
Scroll Window
Select All
Select Dictionaries
Select Window
Send DDE Execute (Windows)
Send Event
Send Mail
Set Allowed Orientations
Set Error Capture
Set Field
Set Field By Name
Set Layout Object Animation
Set Multi-User
Set Next Serial Value
Set Selection
Set Use System Formats
Set Variable
Set Web Viewer
Set Window Title
Set Zoom Level
Show All Records
Show Custom Dialog
Show Omitted Only
Show/Hide Menubar
Show/Hide Text Ruler
Show/Hide Toolbars
Sort Records
Sort Records by Field
Speak (OS X)

FILEMAKER PRO SCRIPT STEPS REFERENCE

235
255
66
17
268
139
71
141
13
15
198
197
196
244
265
173
211
105
103
205
119
194
132
134
136
175
70
219
162
266
272
257
179
33
74
76
37
191
78
68
193
35
253
180
181
147
240
148
176
178
177
152
154
246

9

Script steps reference (alphabetical list)

Spelling Options
Undo/Redo
Unsort Records
Upload To FileMaker Server
View As

FILEMAKER PRO SCRIPT STEPS REFERENCE

218
61
156
236
182

10

About script steps

About script steps
Creating scripts to automate tasks
Scripts can do simple tasks like setting print orientation or complex tasks like preparing a
customized mailing to each client.
For example, you could define a complex set of tasks that creates a thank you email to clients in the
Clients database who have made purchases in the last week. The script composes an email tailored
to each client. The script switches to Preview mode and pauses so you can see what the message
looks like before it is sent. The whole task is initiated by clicking a button on the Sales Entry layout.
You build scripts by selecting from a list of FileMaker Pro commands, called scripts steps, specifying
options (if necessary), and arranging the steps in the correct order to perform the task.

Using this script steps reference
The content in this document was originally written for FileMaker Pro Help. It has been collected in
this format to allow solution developers to read the information independent of the help system.
Links to help topics may not work in this format.
Script step topics are organized by category. Each script step topic describes what the script step
does, and what its options and parameters are. Each topic also shows the format for the script step
and provides a usage example.

Learning about scripts
If you’re new to scripting, use the following resources to learn about scripts.
To view help topics about scripting:
• In FileMaker Pro, choose Help menu > FileMaker Pro Help. In the help window, choose
Designing and creating databases, then choose Creating scripts to automate tasks.
You can also search help for information about scripting.
To view all help topics about individual script steps:
• In FileMaker Pro, choose Help > FileMaker Pro Help. In the help window, choose
Reference > Script steps reference.
To view answers to frequently asked questions, tips, troubleshooting advice, and more, visit the
FileMaker Knowledge Base at http://help.filemaker.com.

FILEMAKER PRO SCRIPT STEPS REFERENCE

11

Control script steps

Control script steps
Control script steps control the progression of the script by letting you tell FileMaker Pro exactly
what to do when and if specific conditions occur.
Use these script steps to:
• call scripts and sub-scripts
• pause and resume a script, based on defined conditions
• conditionally perform script steps using if/then/else logic
• stop a script before it's finished, if a specific condition is met
• create loops that repetitively carry out a sequence of steps in a script, until a condition is
met
Note When you perform a script that uses the Get(LastError) function with control script steps, the
following control script steps do not clear the last error condition reported by FileMaker Pro: If, Else,
Else If, End If, Loop, Exit Loop If, End Loop, Exit Script, and Halt Script.

FILEMAKER SCRIPT STEPS REFERENCE

12

Control script steps

Perform Script
Purpose
Performs a script that is defined in the current file or in another FileMaker Pro file.

Format
Perform Script [“