Claris FileMaker Server 19
Custom Web Publishing Guide© 2004–2020 Claris International Inc. All rights reserved.
Claris International Inc.
5201 Patrick Henry Drive
Santa Clara, California 95054
FileMaker, FileMaker Cloud, FileMaker Go and the file folder logo are trademarks of Claris International Inc., registered in the U.S. andother countries. Claris, the Claris logo, Claris Connect, and FileMaker WebDirect are trademarks of Claris International Inc. All othertrademarks are the property of their respective owners.
FileMaker product documentation is copyrighted. You are not authorized to make additional copies or distribute this documentation without
written permission from Claris. 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. Product credits are listed in the Acknowledgments documents provided withthis software. Documentation credits are listed in the Documentation Acknowledgments. Mention of third-party products and URLs is for
informational purposes only and constitutes neither an endorsement nor a recommendation. Claris International Inc. assumes noresponsibility with regard to the performance of these products.
For more information, visit our website.
Edition: 01

Contents
Preface
About this guide
Where to find FileMaker product documentation

Chapter 1
Introducing Custom Web Publishing
About the Web Publishing Engine
How a Web Publishing Engine request is processed
Custom Web Publishing with XML
Custom Web Publishing with PHP
Comparing XML to PHP
Reasons to choose XML
Reasons to choose PHP

Chapter 2
Preparing databases for Custom Web Publishing
Enabling Custom Web Publishing in a database
Accessing a protected database
Protecting your published databases
Web server support for internet media types (MIME)
About publishing the contents of container fields on the web
Container field objects embedded in a database
Container fields with stored file references
Container fields with externally stored data
Container fields and progressive download
How web users view container field data
FileMaker scripts and Custom Web Publishing
Script tips and considerations
Script behavior in Custom Web Publishing solutions
Script triggers and Custom Web Publishing solutions

Chapter 3
About Custom Web Publishing with XML
Creating dynamic websites with the Web Publishing Engine
Key features in Custom Web Publishing with XML
Web publishing requirements
What is required to publish a database using Custom Web Publishing
What web users need to access a Custom Web Publishing solution
Connecting to the internet or an intranet
Where to go from here

8
8
8

9
10
10
11
11
11
11
12

13
13
13
14
15
15
15
16
16
17
17
17
18
19
19

20
20
21
21
21
21
22
22

Contents

Chapter 4
Accessing XML data with the Web Publishing Engine
Using Custom Web Publishing with XML
Comparing the Web Publishing Engine with XML import and export
How the Web Publishing Engine generates XML data from a request
General process for accessing XML data from the Web Publishing Engine
About the URL syntax for XML data and container objects
About the URL syntax for XML data
About the URL syntax for FileMaker Pro container objects in XML solutions
About URL text encoding
Accessing XML data via the Web Publishing Engine
About namespaces for FileMaker XML
About FileMaker Pro database error codes
Retrieving the document type definitions for the FileMaker grammars
Using the fmresultset grammar
Description of elements in the fmresultset grammar
XML data in the fmresultset grammar
Using other FileMaker XML grammars
Description of elements in the FMPXMLRESULT grammar
XML data in the FMPXMLRESULT grammar
Description of elements in the FMPXMLLAYOUT grammar
XML data in the FMPXMLLAYOUT grammar
About UTF-8 encoded data
Using FileMaker query strings to request XML data
Switching layouts for an XML response
Understanding how an XML request is processed
Troubleshooting XML document access

Chapter 5
Valid names used in XML query strings
About the query commands and parameters
Guidelines for using query commands and parameters
Query command parsing
About the syntax for a fully qualified field name
Using query commands with portal fields
About the syntax for specifying a global field
Query command reference–dbnames (Database names) query command–delete (Delete record) query command–dup (Duplicate record) query command–edit (Edit record) query command–find, –findall, or –findany (Find records) query commands–findquery (Compound find) query command–layoutnames (Layout names) query command–new (New record) query command–scriptnames (Script names) query command–view (View layout information) query command

4

23
23
23
24
25
25
25
26
27
28
28
29
29
29
30
32
33
33
34
35
37
38
38
40
41
41

42
42
43
44
45
45
47
47
47
47
48
48
49
49
50
50
51
51

Contents

Query parameter reference–db (Database name) query parameter–delete.related (Portal records delete) query parameter–field (Container field name) query parameterfieldname (Non-container field name) query parameterfieldname.op (Comparison operator) query parameter–lay (Layout) query parameter–lay.response (Switch layout for response) query parameter–lop (Logical operator) query parameter–max (Maximum records) query parameter–modid (Modification ID) query parameter–query (Compound find request) query parameter–recid (Record ID) query parameter–relatedsets.filter (Filter portal records) query parameter–relatedsets.max (Limit portal records) query parameter–script (Script) query parameter–script.param (Pass parameter to Script) query parameter–script.prefind (Script before Find) query parameter–script.prefind.param (Pass parameter to Script before Find) query parameter–script.presort (Script before Sort) query parameter–script.presort.param (Pass parameter to Script before Sort) query parameter–skip (Skip records) query parameter–sortfield (Sort field) query parameter–sortorder (Sort order) query parameter

Chapter 6
About Custom Web Publishing with PHP
Key features in Custom Web Publishing with PHP
Custom Web Publishing requirements
What is required to publish a database using Custom Web Publishing
What web users need to access a Custom Web Publishing solution
Connecting to the internet or an intranet
Manually installing the FileMaker API for PHP
Where to go from here

Chapter 7
Overview of Custom Web Publishing with PHP
How the Web Publishing Engine works with PHP solutions
General steps for Custom Web Publishing with PHP

Chapter 8
Using the FileMaker API for PHP
Where to get additional information
FileMaker API for PHP Reference
FileMaker API for PHP support

5

51
51
52
52
52
53
54
54
55
55
56
56
57
58
59
59
60
60
60
61
61
62
62
63

64
64
64
64
65
65
66
67

68
68
68

70
70
70
70

Contents

Using the FileMaker class
FileMaker class objects
FileMaker command objects
Decoding data for use in the FileMaker API
Connecting to a FileMaker Pro database
Working with records
Creating a record
Duplicating a record
Editing a record
Deleting a record
Running FileMaker scripts
Obtaining the list of available scripts
Running a FileMaker script
Running a script before executing a command
Running a script before sorting a result set
Running a script after the result set is generated
Script execution order
Working with FileMaker Pro layouts
Using portals
Listing the portals defined on a specific layout
Obtaining portal names for a specific result object
Obtaining information about portals for a specific layout
Obtaining information for a specific portal
Obtaining the table name for a portal
Obtaining the portal records for a specific record
Creating a new record in a portal
Deleting a record from a portal
Using value lists
Obtaining the names of all value lists for a specific layout
Obtaining an array of all value lists for a specific layout
Obtaining the values for a named value list
Performing find requests
Using the Find All command
Using the Find Any command
Using the Find command
Using a Compound Find command
Processing the records in a result set
Limiting the portal rows returned by find requests
Prevalidating commands, records, and fields
Prevalidating records in a command
Prevalidating records
Prevalidating fields
Processing the validation errors
Handling errors

6

71
71
71
72
72
73
73
73
74
74
75
75
75
75
76
76
76
77
78
78
78
78
78
79
79
79
79
80
80
80
80
81
82
82
82
83
85
86
86
88
88
88
88
90

Chapter 9
Staging, testing, and monitoring a site

91

Staging a Custom Web Publishing site91

Contents

Testing a Custom Web Publishing site
Stylesheets for testing XML output
Monitoring your site
Using the web server access and error logs
Using the Web Publishing Engine log
Using the Web Server Module error log
Using the Tomcat logs

Appendix A
Error codes for Custom Web Publishing
Error code numbers in XML format
Error code numbers for FileMaker Pro databases

Index

7

92
93
94
94
94
96
96

97
97
98
99

Preface
About this guideThis guide assumes you are experienced with using Claris™ FileMaker® Pro to create databases.
You should understand the basics of FileMaker Pro database design and the concepts of fields,
relationships, layouts, portals, and containers. For information about FileMaker Pro, see
FileMaker Pro Help.
This guide also assumes you are experienced with developing websites, especially with using
technologies like XML or PHP to integrate FileMaker data with websites and web applications.
This guide provides the following information about Custom Web Publishing with Claris
FileMaker Server:

1 what is required to develop a Custom Web Publishing solution
1
1
1
1

how to publish your databases using XML
how to obtain XML data from databases hosted by FileMaker Server
how to publish your databases using PHP
how to use the FileMaker API for PHP to obtain data from databases hosted byFileMaker Server

1 what web users need to access a Custom Web Publishing solution

Where to find FileMaker product documentation
1 FileMaker Server Help is available on each page of FileMaker Server Admin Console. Scroll tothe bottom of the page and click Help.

1 FileMaker Server documentation is accessible on each page of Admin Console. Scroll to thebottom of the page and click Documentation.

1 On the web, go to the Product Documentation Center.

Chapter 1
Introducing Custom Web Publishing
With FileMaker Server, you can publish your FileMaker Pro database on the internet or an intranet
in these ways.
FileMaker WebDirect: With Claris FileMaker WebDirect™, you can quickly and easily publish
layouts from a database on the web. You don’t need to install additional software—with compatible
web browser software and access to the internet or an intranet, web users can connect to yourFileMaker WebDirect solution to view, edit, sort, or search records if you give them accessprivileges.
With FileMaker WebDirect, the host computer must be running FileMaker Server. The userinterface resembles the desktop FileMaker Pro application. The webpages and forms that the web
user interacts with are dependent on the layouts and views defined in the FileMaker Pro database.
See FileMaker WebDirect Guide.
Static publishing: If your data rarely changes, or if you don’t want users to have a live connection
to your database, you can use static publishing. With static publishing, you export data from a
FileMaker Pro database to create a webpage that you can further customize with HTML. The
webpage doesn’t change when information in your database changes, and users don’t connect toyour database. (With FileMaker WebDirect, the data is updated in the web browser whenever thedata is updated in the database.) See FileMaker Pro Help.
FileMaker Data API: If you’re experienced with using Representational State Transfer (REST)
architecture, the Claris FileMaker Platform provides a REST API implementation that allows web
services to access data in hosted solutions. Your web service calls the FileMaker Data API to
obtain an authentication token for access to a hosted solution, then uses that token in subsequentcalls to create records, update records, delete records, and perform find requests. The FileMaker
Data API returns data in JavaScript Object Notation (JSON). See FileMaker Data API Guide.
Custom Web Publishing: To integrate your FileMaker Pro database with a custom website, use
the Custom Web Publishing technologies available with FileMaker Server. FileMaker Server,which hosts the published databases, does not require FileMaker Pro to be installed or running for
Custom Web Publishing to be available.
With Custom Web Publishing, you can:1 Integrate your database with another website
1 Determine how users interact with data
1 Control how data displays in web browsers
FileMaker Server provides two Custom Web Publishing technologies:

1 Custom Web Publishing with XML: Use XML data publishing to exchange FileMaker data withother websites and applications. By using HTTP URL requests with FileMaker querycommands and parameters, you can query a database hosted by FileMaker Server, download
the resulting data in XML format, and use the resulting XML data in whatever way you want.

1 Custom Web Publishing with PHP: Use the FileMaker API for PHP, which provides an objectoriented PHP interface to FileMaker Pro databases, to integrate your FileMaker data into a PHP
web application. Because you code the PHP webpages yourself, you have complete control
over the user interface and how the user interacts with the data.

Chapter 1 | Introducing Custom Web Publishing

10

About the Web Publishing Engine
To support FileMaker WebDirect and Custom Web Publishing, FileMaker Server uses a set ofsoftware components called the FileMaker Server Web Publishing Engine. The Web Publishing
Engine handles interactions between a web user’s browser, your web server, andFileMaker Server.
Custom Web Publishing with XML: Web users access your Custom Web Publishing solution byclicking an HREF link or by entering a Uniform Resource Locator (URL) that specifies the web
server address and a FileMaker query string request. The Web Publishing Engine returns the XMLdata specified in the query string request.
Custom Web Publishing with PHP: When a web user accesses your Custom Web Publishingsolution, PHP on FileMaker Server connects with the Web Publishing Engine and responds
through the FileMaker API for PHP.

Products.fmp12 Customers.fmp12

1

2
Web ServerWeb
Browser3
Web Publishing Engine

Web Server Module
FM API and PHP code

6

Database
ServerWeb Publishing Core

5

4

Using the FileMaker Server Web Publishing Engine for Custom Web Publishing

How a Web Publishing Engine request is processed
1. A request is sent from a web browser or application to the web server.
2. The web server routes the request through FileMaker Web Server Module to the Web
Publishing Engine.
3. The Web Publishing Engine requests data from the database hosted by the Database Server.
4. The FileMaker Server sends the requested FileMaker data to the Web Publishing Engine.
5. The Web Publishing Engine converts the FileMaker data to respond to the request.

1 For PHP requests, the FileMaker API for PHP converts the PHP request into an XML

request. The Web Publishing Engine processes the XML request and sends XML data backto the FileMaker API for PHP. The FileMaker API for PHP then converts the XML data into
PHP objects that can be used by the PHP application.

1 For XML requests, the Web Publishing Engine sends XML data directly to the web server.
6. The web server sends the output to the requesting web browser or program.
Important Security is important when you publish data on the web. Review the security
guidelines in FileMaker Security Guide.

Chapter 1 | Introducing Custom Web Publishing

11

For information about getting a database ready for Custom Web Publishing, see chapter 2,“Preparing databases for Custom Web Publishing.”

Custom Web Publishing with XML
FileMaker Custom Web Publishing with XML enables you to send query requests to a
FileMaker Pro database hosted by FileMaker Server and to display, modify, or manipulate theresulting data. Using an HTTP request with the appropriate query commands and parameters, you
can retrieve FileMaker data as an XML document. You can then export the XML data to otherapplications.

Custom Web Publishing with PHP
The FileMaker API for PHP provides an object-oriented PHP interface to FileMaker Pro
databases. The FileMaker API for PHP enables both data and logic stored in a FileMaker Pro
database to be accessed and published on the web, or exported to other applications. The API
also supports complex and compound find commands for extracting and filtering data stored in
FileMaker Pro databases.
Originally designed as a procedural programming language, PHP has been enhanced as an
object-oriented web development language. PHP provides programming language functionality
for constructing virtually any type of logic within a site page. For example, you can use conditional
logic constructs to control page generation, data routing, or workflow. PHP also provides for site
administration and security.

Comparing XML to PHP
The following sections provide some guidelines for determining the best solution for your site.

Reasons to choose XML
1 FileMaker XML request parameter syntax is designed for database interaction, which simplifies
solution development.

1 XML is a W3C standard.
1 XML is a machine- and human-readable format that supports Unicode, enabling data to becommunicated in any written language.

1 XML is well-suited for presenting records, lists, and tree-structured data.
1 You can use FMPXMLRESULT for accessing XML data using Custom Web Publishing and forexporting XML from FileMaker Pro databases.

Note For information about Custom Web Publishing with XML, see chapter 3, “About Custom
Web Publishing with XML.”Chapter 1 | Introducing Custom Web Publishing

12

Reasons to choose PHP
1 PHP is a more powerful, object-oriented procedural scripting language, but is relatively easy tolearn. There are many resources available for training, development, and support.

1 The FileMaker API for PHP enables data and logic stored in a FileMaker Pro database to beaccessed and published on the web, or exported to other applications.

1 PHP lets you use conditional logic to control page construction or flow.
1 PHP provides programming language functionality for constructing many types of logic on a site
page.

1 PHP is one of the most popular web scripting languages.
1 PHP is an open source language, available at php.net.
1 PHP enables access to a wide variety of third-party components that you can integrate into yoursolutions.

Note For information about Custom Web Publishing with PHP, see chapter 6, “About Custom
Web Publishing with PHP.”

Chapter 2
Preparing databases for Custom Web
Publishing
Before you can use Custom Web Publishing with a database, you must prepare the database andprotect it from unauthorized access.

Enabling Custom Web Publishing in a database
You must enable a Custom Web Publishing extended privilege in each database you want topublish. If you don’t enable a Custom Web Publishing extended privilege in the database, webusers won’t be able to use Custom Web Publishing to access the database even if it is hosted byFileMaker Server that is configured to support a Web Publishing Engine.
To enable Custom Web Publishing for a database:
1. In FileMaker Pro, open the database you want to publish using an account that has the Full
Access privilege set. Alternatively, you can open the database using an account that has theManage Extended Privileges access privileges.
2. Assign the Custom Web Publishing extended privilege that you want to use:

1 For Custom Web Publishing with XML, use fmxml
1 For Custom Web Publishing with PHP, use fmphp
3. Assign a privilege set that includes the Custom Web Publishing extended privilege to one ormore accounts, or to the Admin or Guest account.
Note When defining account names and passwords for Custom Web Publishing solutions, use
printable ASCII characters, for example a-z, A-Z, and 0-9. For more secure account names andpasswords, include punctuation characters such as “!” and “%,” but do not include colons. For
information on setting up accounts, see FileMaker Pro Help.

Accessing a protected database
Custom Web Publishing enables you to restrict access to your published databases throughdatabase password protection, database encryption, and secure connections. When using a
Custom Web Publishing solution to access a database, web users may be prompted for theiraccount information. If the Guest account for the database is disabled or does not have a privilege
set enabled that includes a Custom Web Publishing extended privilege, the Web Publishing
Engine uses HTTP Basic Authentication to request authentication from web users. The web user’s
browser displays the HTTP Basic Authentication dialog box for the user to enter a user name andpassword for an account that has a Custom Web Publishing extended privilege.

Chapter 2 | Preparing databases for Custom Web Publishing

14

The following list summarizes the process that occurs when a web user uses a Custom Web
Publishing solution to access a database:1 If you have not assigned a password for an account, web users only specify the account name.
1 If the Guest account is disabled, then users will be prompted for account name and password
when they access the database. The account must have a Custom Web Publishing extended
privilege enabled.

1 If the Guest account is enabled and has a privilege set enabled that includes a Custom Web

Publishing extended privilege, all web users automatically open the database with the accessprivileges assigned to the Guest account. If the Custom Web Publishing extended privilege isassigned to the Guest account:

1 Web users are not prompted for an account name and password when opening a file.
1 All web users will automatically sign in with the Guest account and assume the Guest

account privileges. You can let users change their sign-in accounts from a web browser with
the Re-Login script step (for example, to switch from the Guest account to an account withmore privileges).

1 The default privilege set for Guest accounts provides “read-only” access. You can change
the default privileges, including extended privileges, for this account. See FileMaker Pro
Help.

1 When a web user has entered valid account information, that account information is reused aslong as the browser session has not timed out. When the browser session times out, then the
web user is again prompted to enter a valid account.

Note By default, web users cannot modify their account password from a web browser. You canbuild this feature into a database with the Change Password script step, which allows web users
to change their passwords from their browser. See FileMaker Pro Help.

Protecting your published databases
When using Custom Web Publishing, you can limit who can access your published databases.

1 Assign passwords to database accounts that are used for Custom Web Publishing.
1 Enable a Custom Web Publishing extended privilege only in the privilege sets for accounts thatyou want to allow access to your published databases.

1 Disable the Custom Web Publishing extended privilege for a specific database by deselecting

the fmxml or fmphp extended privilege for all privilege sets in that database. See FileMaker Pro
Help.

1 Enable or disable Custom Web Publishing for all Custom Web Publishing solutions using thecommand line interface (CLI). In addition, use FileMaker Server Admin Console to start or stop
the Web Publishing Engine. See FileMaker Server Help.

1 Configure your web server to restrict the IP addresses that can access your databases via the

Web Publishing Engine. For example, you can specify that only web users from the IP address
192.168.100.101 can access your databases. For information on restricting IP addresses, see
the documentation for your web server.

Chapter 2 | Preparing databases for Custom Web Publishing

15

FileMaker Server supports encryption for data written to disk and for data transmitted to clients.

1 Encrypt your database by using the Database Encryption feature of FileMaker Pro. Encryption
protects the FileMaker Pro database file and any temporary files written to disk. See
FileMaker Server Installation and Configuration Guide and FileMaker Pro Help.

1 An encrypted database that is hosted on FileMaker Server is opened by using Admin

Console or the CLI. As the FileMaker Server administrator, you open the file with its
database encryption password, so that FileMaker clients can use the encrypted database.

1 Once the FileMaker encrypted database is opened with the encryption password by the

FileMaker Server administrator, FileMaker clients don’t need the encryption password toaccess the encrypted database. For information about opening an encrypted database, see
FileMaker Server Help.

1 Use Secure Sockets Layer (SSL) encryption for communication between the web server andweb browsers. SSL connections are accessed through an HTTPS connection.
FileMaker Server provides a standard SSL certificate signed by Claris International Inc. that
does not verify the server name. The FileMaker default certificate is intended only for test
purposes. A custom SSL certificate is required for production use. See FileMaker Server
Installation and Configuration Guide.

When you import a custom SSL certificate, Database Server client connections use SSL; HTTP
connections are routed to HTTPS. With a custom SSL certificate, use the HTTPS directory for
hosting PHP site files. See chapter 7, “General steps for Custom Web Publishing with PHP.”
For information on securing your database, see FileMaker Security Guide.
Note For security reasons, webpages hosted by other web servers may not use the <iframe> tag
to embed Custom Web Publishing content. If you want to embed Custom Web Publishing content
in the <iframe> tags of separate webpages, those webpages must be hosted by the
FileMaker Server web server.

Web server support for internet media types (MIME)Your web server determines the support for the current MIME (Multipurpose Internet Mail
Extensions) types registered for the internet. The Web Publishing Engine does not change a web
server’s support for MIME. See the documentation for your web server.

About publishing the contents of container fields on the web
The contents of a container field can be embedded in the database, linked by reference using a
relative path, or stored externally.

Container field objects embedded in a database
If a container field stores the actual files in the FileMaker Pro database, then you don’t need to do
anything with the container field contents if the database file is properly hosted and accessible on
FileMaker Server. See “About the URL syntax for FileMaker Pro container objects in XML
solutions” on page 26.

Chapter 2 | Preparing databases for Custom Web Publishing

16

Container fields with stored file references
If a container field stores a file reference, then you must follow these steps to publish thereferenced files using the Web Publishing Engine.
1. Store the container object files in the Web folder inside the FileMaker Pro folder.
2. In FileMaker Pro, insert the objects into the container field and select the Store only areference to the file option.
3. Copy or move the referenced object files in the Web folder to the same relative path location in
the root folder of the web server software.

1 For IIS (Windows):[drive]:\Program Files\FileMaker\FileMaker Server\HTTPServer\confwhere [drive] is the drive on which the Web Publishing Engine component of yourFileMaker Server deployment resides.

1 For Apache (macOS): /Library/FileMaker Server/HTTPServer/htdocs
Note For container objects stored as file references, your web server must be configured tosupport the MIME types for the kinds of files you want to serve, such as movies. Your web server
determines the support for the current MIME types registered for the internet. The Web Publishing
Engine does not change a web server’s support for MIME. See the documentation for your web
server.

Container fields with externally stored data
If a container field stores objects externally—that is, if you selected Store container data
externally in the FileMaker Pro Options for Field dialog box—use FileMaker Pro to transfer
database files from the client file system to FileMaker Server. When you use FileMaker Pro to
upload a database, the externally stored container field data is uploaded to FileMaker Server aspart of the process. See FileMaker Pro Help for information on transferring the database files to
FileMaker Server.
When you manually upload a database that uses a container field with externally stored objects,
then you must follow these steps to publish the externally stored container objects using the Web
Publishing Engine.
To upload a database manually:
1. Place the database file in the proper location on the server. Place the FileMaker Pro databasefiles that you want FileMaker Server to open—or shortcuts (Windows) or aliases (macOS) to
those files—in the following folders:

1 Windows:[drive]:\Program Files\FileMaker\FileMaker Server\Data\Databases\
where [drive] is the primary drive from which the system is started.

1 macOS: /Library/FileMaker Server/Data/Databases/
Or you can place the files in an optionally specified additional database folder.
2. In the folder where you placed the database, create a folder named RC_Data_FMS, if it
doesn’t already exist.

Chapter 2 | Preparing databases for Custom Web Publishing17

3. In the RC_Data_FMS folder, create a folder with a name that matches the name of yourdatabase. For example, if your database is named Customers, then create a folder named
Customers. Place the externally stored objects in the new folder you created.
Note When databases are hosted on FileMaker Server, there is no way for multiple databases
to share a common folder of container objects. The container objects for each database needs
to be in a folder identified by that database’s name.
4. For files that will be shared from macOS, change the files to belong to the fmsadmin group.
For information about manually uploading databases, see FileMaker Server Help.

Container fields and progressive download
The Web Publishing Engine supports progressive download of audio files (.mp3), video files (.mov,.mp4, and .avi recommended), and PDF files for interactive containers. For example, a web user
may start viewing a movie even if the entire movie file has not yet downloaded. To allow for
progressive download, you may need to create the files using options that support streaming orthat optimize for display on the web. For example, create PDF files using the option to optimize
for web viewing.
When you import a custom SSL certificate, Database Server client connections use SSL; HTTP
connections are routed to HTTPS. FileMaker Server uses secure connections to transmit dataover HTTPS.

1 Interactive container data is downloaded over HTTPS.
1 The data is as secure as if the hosted solution were a local database, since no temporary cache
files are created and the data is encrypted during transmission.

When you do not have a custom SSL certificate, the connections that FileMaker Server uses totransmit data are not encrypted during transmission and data is transmitted over HTTP.

1 FileMaker clients see the interactive container data with minimal delay.
1 FileMaker Server caches the container field data to a cache folder on the server when a

FileMaker Pro, Claris FileMaker Go®, or web client requests the data. The data may remain in
the cache folder on the server for two hours, until FileMaker Server periodically empties thecache folder. The data is not cached locally on the client.

How web users view container field data
When you publish a database using the Web Publishing Engine, the following limitations apply tocontainer field objects:

1 Web users cannot modify or add to the contents of container fields. Web users cannot use
container fields to upload objects to the database.

1 For databases that use a container field with thumbnails enabled, the Web Publishing Engine
downloads the full file, not a thumbnail.

FileMaker scripts and Custom Web Publishing
The Manage Scripts feature in FileMaker Pro can automate frequently performed tasks andcombine several tasks. When used with Custom Web Publishing, FileMaker scripts allow web
users to perform more tasks or a series of tasks.

Chapter 2 | Preparing databases for Custom Web Publishing18

The FileMaker Platform supports many script steps in Custom Web Publishing. Web users canperform a variety of automated tasks when you use scripts in a query string for a URL. To see
script steps that Custom Web Publishing supports, in the FileMaker Pro Script Workspace window,
click the Compatibility button and choose Custom Web Publishing. Script steps that are notdimmed are supported for Custom Web Publishing. For information on creating scripts, see
FileMaker Pro Help.

Script tips and considerations
Although many script steps work identically on the web, there are several that work differently. See“Script behavior in Custom Web Publishing solutions” on page 19. Before sharing your database,evaluate all scripts that will be executed from a web browser. Be sure to sign in with different user
accounts to make sure they work as expected for all clients. Check the Web Publishing Engine log
file (wpe.log) for any scripting-related errors. See “Using the Web Publishing Engine log” onpage 94.
Keep these tips and considerations in mind:

1 Consider what values a script may return. Be prepared to handle all of the data that is returned.
In FileMaker Pro, a script may return all the records from a table or from the current found set.
But if a script returns all the records from a table, a web application may run out of memory
trying to processing the records. Consider using the –max query parameter with XML queries
or the setRange()method with PHP queries to limit the number of records returned.

1 Use accounts and privileges to restrict the set of scripts that a web user can execute. Verify thatthe scripts contain only web-compatible script steps, and only provide access to scripts thatshould be used from a web browser.

1 Consider the side effects of scripts that execute a combination of steps that are controlled byaccess privileges. For example, if a script includes a step to delete records, and a web user
does not sign in with an account that allows record deletion, the script will not execute theDelete Records script step. However, the script might continue to run, which could lead to
unexpected results.

1 In the Script Workspace window, grant full access privileges to a script to allow the script toperform tasks that you would not grant individuals access to. For example, you can prevent
users from deleting records with their accounts and privileges, but still allow them to run a scriptthat would delete certain types of records under conditions predefined within a script.

1 To allow scripts to install plug-ins for Custom Web Publishing and FileMaker WebDirect

solutions, use FileMaker Server Admin Console to enable the necessary settings. For Web
Publishing Plug-ins, set Web Publishing Plug-ins and Install Plug-in File Script Step toEnabled. To prevent script from installing plug-ins for web publishing solutions, set them toDisabled.

1 Some scripts that work with one step from a FileMaker Pro client may require an additional

Commit Record/Request script step to save the data to the host. Because web users don’t havea direct connection to the host, they aren’t notified when data changes. For example, features
like conditional value lists aren’t as responsive for web users because the data must be saved
to the host before the effects are seen in the value list field.

Chapter 2 | Preparing databases for Custom Web Publishing

19

1 Any script that modifies data should include the Commit Record/Request script step, because

data changes aren’t visible in the browser until the data is saved or “submitted” to the server.
This includes several script steps like Cut, Copy, and Paste. Many single-step actions should
be converted into scripts to include the Commit Record/Request step. When designing scriptsthat will be executed from a web browser, include the Commit Record/Request step at the endof a script to make sure all changes are saved.

1 Scripts dependent on data that has been changed but not yet committed may not work as they
do with a FileMaker Pro client. For example, if a field contains a Get(ModifiedFields)
calculation, when the record is edited through an XML query or a PHP call, theGet(ModifiedFields) calculation returns an empty list. However, if the Custom Web Publishingsolution runs a FileMaker script that edits the record, the Get(ModifiedFields) calculation
returns a list of fields that were edited by the script.

1 To create conditional scripts based on the type of client, use the Get(ApplicationVersion)function. If the value returned includes a “Web Publishing Engine” string, then you know thatthe current user is accessing your database with Custom Web Publishing. For information on
functions, see FileMaker Pro Help.

1 Open each script that web users might run, and verify that the script will execute properly when
the database is hosted as a Custom Web Publishing solution. Check that the script uses only
script steps that are supported for Custom Web Publishing, as described above.

Script behavior in Custom Web Publishing solutions
Some script steps function differently in Custom Web Publishing solutions than in FileMaker Pro.
See FileMaker Pro Help for compatibility information.
Scripts in Custom Web Publishing solutions cannot perform scripts in other FileMaker Pro files
unless the files are hosted on the same installation of FileMaker Server and unless the same
Custom Web Publishing extended privilege is enabled in the other files.

Script triggers and Custom Web Publishing solutions
In FileMaker Pro, both scripts and user actions (such as the user clicking a field) can activate script
triggers. But in Custom Web Publishing, only scripts can activate script triggers.
For information on script triggers, see FileMaker Pro Help.
Note In Custom Web Publishing solutions, the OnFirstWindowOpen script trigger is not
activated. The OnLastWindowClose script trigger is activated only when a script closes the lastvirtual window. You can run scripts manually using the XML –script query parameter or the PHP
newPerformScriptCommand() method.

Chapter 3
About Custom Web Publishing with XML
Creating dynamic websites with the Web Publishing Engine
The Web Publishing Engine provides Custom Web Publishing for FileMaker Server using XML
data publishing. Custom Web Publishing provides several benefits:

1 Customization: You can determine how web users interact with FileMaker data, and how thedata displays in web browsers.

1 Data interchange: By using FileMaker XML, you can exchange FileMaker data with otherwebsites and applications.

1 Data integration: You can integrate FileMaker data into other websites, with other middleware,and with custom applications. You can make the data look like it belongs to another website
instead of displaying an entire FileMaker Pro layout in the web browser.

1 Security: The FileMaker Server administrator can enable or disable XML web publishing for all
databases hosted by the server. As the FileMaker Pro database owner, you can control web
user access to XML web publishing for each database.

1 Control and filtering of published data: You can control and filter the data and the type of

database information you want to publish, which prevents unauthorized use of the database.
You can also hide metadata, such as database and field names.

1 Based on an open standard: You have more access to tools, resources and skilled personnel

for Custom Web Publishing solutions. If you know standard XML, then you can start developing
solutions after learning a few unique details about Custom Web Publishing with XML, such as
the URL syntax and query parameters to use.

Custom Web Publishing with XML allows you to retrieve data from FileMaker Pro databases, andeasily use the data in other output formats. By using an HTTP request with the appropriate querycommands and parameters, you can retrieve FileMaker data as an XML document. You can thenuse the XML data in other applications. See “Accessing XML data via the Web Publishing Engine”
on page 28.

Chapter 3 | About Custom Web Publishing with XML

21

Key features in Custom Web Publishing with XML
FileMaker Server Custom Web Publishing with XML provides several important features:

1 Databases are hosted on FileMaker Server, and FileMaker Pro is not required to be running.
1 You can use server-side processing of the XML using JavaScript.
1 Like FileMaker Pro, access to data, layouts, and fields is based on the user account settings

defined in the database’s access privileges. The Web Publishing Engine also supports several
other security enhancements. See “Protecting your published databases” on page 14.

1 Web users can perform complex, multistep scripts. The FileMaker Platform supports many

script steps in Custom Web Publishing. See “FileMaker scripts and Custom Web Publishing”
on page 17.

1 You can pass a parameter value to a FileMaker script. See “–script.param (Pass parameter to
Script) query parameter” on page 60, “–script.prefind.param (Pass parameter to Script beforeFind) query parameter” on page 60, and “–script.presort.param (Pass parameter to Script
before Sort) query parameter” on page 61.

1 The fmresultset XML grammar enables you to access fields by name and manipulate
relatedset (portal) data.

1 To access data in a database, you must specify a layout. See chapter 5, “Valid names used in
XML query strings.”

Web publishing requirements
What is required to publish a database using Custom Web Publishing
To publish databases using Custom Web Publishing with XML, you need:

1 a FileMaker Server deployment that includes:
1 a web server, either Microsoft IIS (Windows) or Apache (macOS)
1 the FileMaker Database Server, enabled for Custom Web Publishing using the CLI
1 the Web Publishing Engine, installed and configured
1 one or more FileMaker Pro databases hosted by FileMaker Server
1 the IP address or domain name of the host running the web server
1 a web browser and access to the web server to develop and test your Custom Web Publishingsolution

See FileMaker Server Installation and Configuration Guide.

What web users need to access a Custom Web Publishing solution
To access a Custom Web Publishing solution that uses XML, web users need:

1 a web browser
1 access to the internet or an intranet and the web server
1 the IP address or domain name of the host running the web server
If the database is password-protected, web users must also enter a user name and password fora database account.

Chapter 3 | About Custom Web Publishing with XML

22

Connecting to the internet or an intranet
When you publish databases on the internet or an intranet, the host computer must be running
FileMaker Server, and the databases you want to share must be hosted and available. In addition:

1 Publish your database on a computer with a full-time internet or intranet connection. You canpublish databases without a full-time connection, but they are only available to web users whenyour computer is connected to the internet or an intranet.

1 The host computer for the web server that is part of the FileMaker Server deployment musthave a dedicated static (permanent) IP address or a domain name. If you connect to the internetwith an internet service provider (ISP), your IP address might be dynamically allocated (it isdifferent each time you connect). A dynamic IP address makes it more difficult for web users tolocate your databases. If you are not sure of the type of access available to you, consult your
ISP or network administrator.

Where to go from here
Here are some suggestions to get started developing Custom Web Publishing solutions:

1 If you haven’t already done so, use the CLI to enable Custom Web Publishing. See
FileMaker Server Help.

1 In FileMaker Pro, open each FileMaker Pro database that you want to publish and make surethe database has the appropriate extended privileges enabled for Custom Web Publishing. See“Enabling Custom Web Publishing in a database” on page 13.

1 To learn how to access data in FileMaker Pro databases using XML, see “Accessing XML data
via the Web Publishing Engine” on page 28.

Chapter 4
Accessing XML data with the Web Publishing
Engine
You can obtain and update FileMaker data in Extensible Markup Language (XML) format by using
the Web Publishing Engine. Many individuals, organizations, and businesses use XML to transfer
product information, transactions, inventory data, and other business data.

Using Custom Web Publishing with XML
If you know standard XML, you can start using the Web Publishing Engine after learning a few
unique details about Custom Web Publishing with XML, such as the URL syntax and queryparameters to use.
By using HTTP URL requests with FileMaker query commands and parameters, you can query a
database hosted by FileMaker Server and download the resulting data in XML format. For
example, you can query a database for all records in a certain postal code, and use the resulting
XML data in whatever way you want to.
See the Knowledge Base.
Note The Web Publishing Engine generates XML data that is well-formed and compliant with the
XML 1.0 specification. For details about the requirements for well-formed XML, see the XML
specification at www.w3.org.

Comparing the Web Publishing Engine with XML import and export
The Web Publishing Engine and FileMaker Pro both enable you to use XML data with FileMaker
Pro databases. There are, however, some important differences between the two methods:

1 For accessing XML data, the Web Publishing Engine supports the fmresultset,

FMPXMLRESULT, and FMPXMLLAYOUT grammars. For XML import, FileMaker Pro uses the
FMPXMLRESULT grammar, and for export, FileMaker Pro uses the FMPXMLRESULT grammar.
See “Accessing XML data via the Web Publishing Engine” on page 28.

1 To access XML data with the Web Publishing Engine, you use a Web Publishing Engine query
string in a URL. To import and export XML with FileMaker Pro, you use FileMaker Pro menu
commands or scripts.

1 The Web Publishing Engine is server-based and can be installed on the same or a different hostthan FileMaker Server. FileMaker Pro XML import and export is desktop-based.

1 You can dynamically access XML data from FileMaker Pro databases by using URL requests
with the Web Publishing Engine. The FileMaker Pro XML export feature generates a prespecified XML data file.

1 Working with XML data via the Web Publishing Engine is an interactive operation.
FileMaker Pro XML import and export is a batch operation.

1 The Web Publishing Engine can access XML data from a FileMaker Pro portal, but FileMaker
Pro cannot.

1 The Web Publishing Engine can access data in a container field, but FileMaker Pro cannot.

Chapter 4 | Accessing XML data with the Web Publishing Engine

24

1 The Web Publishing Engine provides real-time access to FileMaker data via HTTP or HTTPS,
but FileMaker Pro cannot.

Note For information on using FileMaker Pro to import and export data in XML format, see
FileMaker Pro Help.

How the Web Publishing Engine generates XML data from a request
After a request for XML data is sent to the web server, the Web Publishing Engine queries theFileMaker Pro database and returns the data as an XML document.
Web
Browser
1. HTTP or
HTTPS request
for XML data issent from web
browser or
program to web
server.

FileMaker Server Web
Publishing Engine

3. Web PublishingCore requests datafrom database hosted
by FileMaker
Database Server.

Web Publishing Core

FileMaker Database
ServerWeb Server
Web Server Module

2. Web serverroutes request
to Web
PublishingCore.

Custom Web Publishing
Engine (CWPE)
Products.fmp12

Customers.fmp12

Orders.fmp12

Catalog.fmp12

Request for XML data is routed from web browser or program to FileMaker Database Server

XML data is routed back from FileMaker Database Server to web browser or program
Web
Browser
6. Web server
sends output to
web browser or
program.

5. Web Publishing Core
converts data to XML andsends it to web server.

FileMaker Server Web
Publishing Engine
Web Publishing CoreWeb Server
Web Server Module

Custom Web Publishing
Engine (CWPE)

4. FileMaker database
Server sends requested
data to Web PublishingCore.

Chapter 4 | Accessing XML data with the Web Publishing Engine

25

General process for accessing XML data from the Web Publishing Engine
Here is an overview of the process for using the Web Publishing Engine to access XML data in a
FileMaker Pro database:
1. Using the CLI, make sure XML Publishing is enabled. See FileMaker Server Help.
2. In FileMaker Pro, open each FileMaker Pro database that you’re publishing and make sure thedatabase has the fmxml extended privilege enabled for XML Custom Web Publishing. See“Enabling Custom Web Publishing in a database” on page 13.
To access XML data in a portal, set the view for the database layout to View as Form or View
as List. If a user or script changes the view of the database layout to View as Table, only the
first related record (first row of the portal) is accessible as XML data.
The XML data is output in an order that corresponds to the order in which field objects wereadded to the layout. If you want the XML data order to match the order in which fields appear
on the screen (top-to-bottom, left-to-right), then select all fields, group them, and then ungroupthem. This procedure resets the layout order to match the screen order.
3. In FileMaker Server Admin Console, confirm that each FileMaker Pro database you’re
publishing has the fmxml extended privilege enabled.

1 In Admin Console, click the Databases page.
1 Select Show Extended Privileges from the menu selector next to All Databases. The text
FMXML is displayed for databases that have the fmxml extended privilege enabled.

4. Send an HTTP or HTTPS request in the form of a URL that specifies the FileMaker XML
grammar, one query command, and one or more FileMaker query parameters to the Web
Publishing Engine through an HTML form, an HREF link, or a script in your program orwebpage. You can also type the URL in a web browser.
For information on specifying the URL, see the next section, “About the URL syntax for XML
data and container objects.” For information on query commands and parameters, see “Using
FileMaker query strings to request XML data” on page 38, and chapter 5, “Valid names used in
XML query strings.”
5. The Web Publishing Engine uses the grammar you specified in the URL to generate XML datacontaining the results of your request, such as a set of records from the database, and returns
it to your program or web browser.
6. The web browser, if it has an XML parser, displays the data, or the program uses the data in
the way you specified.

About the URL syntax for XML data and container objects
This section describes the URL syntax for using the Web Publishing Engine to access XML dataand container objects from FileMaker Pro databases.

About the URL syntax for XML data
The URL syntax for using the Web Publishing Engine to access XML data from FileMaker Pro
databases is:<scheme>://<host>[:<port>]/fmi/xml/<xml_grammar>.xml[?<query string>]

Chapter 4 | Accessing XML data with the Web Publishing Engine

26

where:

1 <scheme> can be the HTTP or HTTPS protocol.
1 <host> is the IP address or domain name of the host where the web server is installed.
1 <port> is optional and specifies the port that the web server is using. If no port is specified,then the default port for the protocol is used (port 80 for HTTP, or port 443 for HTTPS).

1 <xml_grammar> is the name of the FileMaker XML grammar. Possible values arefmresultset, FMPXMLRESULT, or FMPXMLLAYOUT. See “Using the fmresultset grammar” onpage 29 and “Using other FileMaker XML grammars” on page 33.

1 <query string> is a combination of one query command and one or more query parametersfor FileMaker XML publishing. (The –dbnames command doesn’t require any parameters.) See“Using FileMaker query strings to request XML data” on page 38, and chapter 5, “Valid names
used in XML query strings.”

Note The URL syntax, including the names of the query command and parameters, is casesensitive except for portions of the query string. The majority of the URL is in lowercase, with the
exception of the two uppercase grammar names: FMPXMLRESULT and FMPXMLLAYOUT. For
information on the rules for case sensitivity of the query string, see “Guidelines for using querycommands and parameters” on page 43.
Examples
http://server.company.com/fmi/xml/fmresultset.xml?-db=products&-lay=sales&-findall
http://192.168.123.101/fmi/xml/FMPXMLRESULT.xml?-db=products&-lay=sales&-findall

About the URL syntax for FileMaker Pro container objects in XML solutions
In a generated XML document for an XML solution, the syntax used to refer to a container object
is different for container fields that store the actual object in the database, as opposed to container
fields that store a reference to the object.
If a container field stores the actual object in the database
The container field’s <data> element uses the following relative URL syntax to refer to the object:<data>/fmi/xml/cnt/data.<extension>?<query string></data>
where <extension> is the filename extension identifying the type of object, such as .jpg. The
filename extension sets the MIME type to allow the web browser to properly identify the container
data. For information on <query string>, see the previous section, “About the URL syntax for
XML data.”
Example<data>/fmi/xml/cnt/data.jpg?-db=products&-lay=sales&-field=product_image(1)&-recid=2</data>Chapter 4 | Accessing XML data with the Web Publishing Engine

27

Note In the generated XML for a container field, the value for the –field query parameter is afully qualified field name. The number in the parentheses indicates the repetition number for thecontainer field, and is generated for both repeating and non-repeating fields. See “About thesyntax for a fully qualified field name” on page 45.
To retrieve the container data from the database, use the following syntax:<scheme>://<host>[:<port>]/fmi/xml/cnt/data.<extension>?<query string>
For information about <scheme>, <host>, or <port>, see the previous section, “About the URL
syntax for XML data.”
Examplehttp://www.company.com/fmi/xml/cnt/data.jpg?-db=products&-lay=sales&-field=product_image(1)&-recid=2

If a container field stores a file reference instead of an actual object
The container field’s <data> element contains a relative path that refers to the object.
Example<data>/images/logo.jpg</data>

Note The referenced container object must be stored in the FileMaker Pro Web folder when therecord is created or edited, and then copied or moved to a folder with the same relative locationin the root folder of the web server software. See “About publishing the contents of container fields
on the web” on page 15.
If a container field is empty
The container field’s <data> element is empty.

About URL text encoding
The URLs for accessing XML data and container objects must be encoded in UTF-8 (Unicode
Transformation 8 Bit) format. See “About UTF-8 encoded data” on page 38.
ExampleTo set the value of the “info” field to fiancée, you could use the following URL:
http://server.company.com/fmi/xml/fmresultset.xml?-db=members&-lay=relationships&-recid=2&info=fianc%C3%A9e&-edit%C3%A9 is the URL encoded UTF-8 representation of the é character.
See the URL specification at www.w3.org.

Chapter 4 | Accessing XML data with the Web Publishing Engine

28

Accessing XML data via the Web Publishing Engine
To access XML data via the Web Publishing Engine, you use a URL that specifies the name of theFileMaker grammar to use, one FileMaker query command, and one or more FileMaker queryparameters. The Web Publishing Engine generates XML data from your database that isformatted by one of the following types of XML grammars:

1 fmresultset: This is the recommended grammar for the Web Publishing Engine for accessing
XML data. It is flexible and is optimized for easier field access by name and for easier
manipulation of relatedset (portal) data. This grammar is also more directly linked toFileMaker terminology and features such as global storage options and identification ofsummary and calculation fields. To facilitate web publishing, this grammar is designed to be
more verbose than the FMPXMLRESULT grammar. See “Using the fmresultset grammar” onpage 29.

1 FMPXMLRESULT and FMPXMLLAYOUT: You can also use the FMPXMLRESULT and

FMPXMLLAYOUT grammars with the Web Publishing Engine for accessing XML data. To use
one stylesheet for both XML export and Custom Web Publishing, you must use the
FMPXMLRESULT grammar. To access value lists and field display information in layouts, youmust use the FMPXMLLAYOUT grammar. See “Using other FileMaker XML grammars” onpage 33.

Depending on the grammar you specify in the URL request, the Web Publishing Engine will
generate an XML document using one of the grammars. Each XML document contains a default
XML namespace declaration for the grammar. See the next section, “About namespaces for
FileMaker XML.” Use one of these grammars in your document or webpage to display and workwith FileMaker data in XML format.
Note XML data generated by the Web Publishing Engine is encoded using UTF-8 format(Unicode Transformation Format 8). See “About UTF-8 encoded data” on page 38.

About namespaces for FileMaker XML
Unique XML namespaces help distinguish XML tags by the application they were designed for.
For example, if your XML document contains two <DATABASE> elements, one for FileMaker XML
data and another for Oracle XML data, the namespaces will identify the <DATABASE> element foreach.
The Web Publishing Engine generates a default namespace for each grammar.
For this grammar

This default namespace is generated

fmresultset

xmlns="http://www.filemaker.com/xml/fmresultset"

FMPXMLRESULT

xmlns="http://www.filemaker.com/fmpxmlresult"

FMPXMLLAYOUT

xmlns="http://www.filemaker.com/fmpxmllayout"Chapter 4 | Accessing XML data with the Web Publishing Engine

29

About FileMaker Pro database error codes
The Web Publishing Engine returns an error code in the error code elements at the beginning ofeach XML document that represents the error, if any, in the execution of the most recently
executed query command. A value of zero (0) is returned for no error.
For this grammar

This syntax is usedfmresultset<error code="0"></error>

FMPXMLRESULT<ERRORCODE>0</ERRORCODE>FMPXMLLAYOUT<ERRORCODE>0</ERRORCODE>

The error code element in the XML document indicates errors related to the database and query
strings. See appendix A, “Error codes for Custom Web Publishing.”

Retrieving the document type definitions for the FileMaker grammars
You can retrieve the document type definitions (DTDs) for the FileMaker grammars by using an
HTTP request.
For this grammar

Use this HTTP request

fmresultset

http://<host>[:<port]/fmi/xml/fmresultset.dtd

FMPXMLRESULT

http://<host>[:<port]/fmi/xml/FMPXMLRESULT.dtd

FMPXMLLAYOUT

http://<host>[:<port]/fmi/xml/FMPXMLLAYOUT.dtd

Using the fmresultset grammar
The XML element names in this grammar use FileMaker terminology, and the storage of fields isseparated from the type of fields. The grammar also includes the ability to identify summary,calculation, and global fields.
To use the fmresultset grammar, specify the following name of the fmresultset grammar in
the URL requesting the XML document from the Web Publishing Engine:
fmresultset.xml

Examplehttp://192.168.123.101/fmi/xml/fmresultset.xml?-db=employees&-lay=family&-findall

Note When specifying the fmresultset grammar, be sure to use lowercase.
The Web Publishing Engine will generate an XML document using the fmresultset grammar.
In the XML document, the Web Publishing Engine will reference the document type definition for
the fmresultset grammar in the <!DOCTYPE> instruction in the second line of the document,
immediately after the <?xml...?> instruction. The <!DOCTYPE> instruction specifies the URL for
downloading the DTD for the fmresultset grammar.

Chapter 4 | Accessing XML data with the Web Publishing Engine

30

Description of elements in the fmresultset grammar
The fmresultset grammar consists primarily of the <datasource> element, the <metadata>
element, and the <resultset> element.
<datasource> element
In the fmresultset grammar, the <datasource> element contains the table, layout, dateformat, time-format, timestamp-format, total-count, and database attributes.

1 The date-format attribute of the <datasource> element specifies the format of dates in the
XML document:
MM/dd/yyyy
where:

1 MM is the 2-digit value for the month (01 through 12, where 01 is January and 12 isDecember)

1 dd is the 2-digit value for the day of the month (01 through 31)
1 yyyy is the 4-digit value for the year
1 The time-format attribute of the <datasource> element specifies the format of times in the
XML document:
HH:mm:ss
where:

1 HH is the 2-digit value for hours (00 through 23, for the 24-hour format)
1 mm is the 2-digit value for minutes (00 through 59)
1 ss is the 2-digit value for seconds (00 through 59)
1 The timestamp-format attribute of the <datasource> element combines the formats of dateformat and time-format into one timestamp:
MM/dd/yyyy HH:mm:ss

Chapter 4 | Accessing XML data with the Web Publishing Engine

31<metadata> element
The <metadata> element of the fmresultset grammar contains one or more <fielddefinition> and <relatedset-definition> elements, each containing attributes for oneof the fields of the result set.
The <field-definition> attributes specify:

1
1
1
1
1
1
1

whether the field is an auto-enter field ("yes" or "no")whether the field is a four-digit-year field ("yes" or "no")whether it is a global field ("yes" or "no")the maximum number of repeating values (max-repeat attribute)the maximum number of characters allowed (max-characters attribute)whether it is a not-empty field ("yes" or "no")whether it is for numeric data only ("yes" or "no")1 result ("text", "number", "date", "time", "timestamp", or "container")
1 whether it is a time-of-day field ("yes" or "no")1 type ("normal", "calculation", or "summary")
1 and the field name (fully qualified as necessary)
The <relatedset-definition> element represents a portal. Each related field in a portal isrepresented by the <field-definition> element contained within the<relatedset-definition> element. If there are multiple related fields in a portal, the fielddefinitions for the related fields are grouped within a single <relatedset-definition>
element.
<resultset> element
The <resultset> element contains the <record> elements returned as the result of a queryand an attribute for the total number of records found. Each <record> element contains the fielddata for one record in the result set—including the mod-id and the record-id attributes for therecord, and the <data> element containing the data for one field in the record.
Each record in a portal is represented by a <record> element within the <relatedset>
element. The count attribute of the <relatedset> element specifies the number of records inthe portal, and the table attribute specifies the table associated with the portal.

Chapter 4 | Accessing XML data with the Web Publishing Engine

32

XML data in the fmresultset grammar
Example<fmresultset xmlns="http://www.filemaker.com/xml/fmresultset" version="1.0"><error code="0"/><product build="03/29/2019" name="FileMaker Web Publishing Engine"version="18.0.1.0"/><datasource database="art" date-format="MM/dd/yyyy" layout="web3"
table="art" time-format="HH:mm:ss" timestamp-format="MM/dd/yyyy HH:mm:ss"
total-count="12"/><metadata><field-definition auto-enter="no" four-digit-year="no" global="no" maxrepeat="1" name="Title" not-empty="no" numeric-only="no" result="text"
time-of-day="no" type="normal"/><field-definition auto-enter="no" four-digit-year="no" global="no" maxrepeat="1" name="Artist" not-empty="no" numeric-only="no" result="text"
time-of-day="no" type="normal"/><field-definition auto-enter="no" four-digit-year="no" global="no" maxrepeat="1" name="Style" not-empty="no" numeric-only="no" result="text"
time-of-day="no" type="normal"/><field-definition auto-enter="no" four-digit-year="no" global="no" maxrepeat="1" name="length" not-empty="no" numeric-only="no"result="number" time-of-day="no" type="calculation"/><relatedset-definition table="artlocations"><field-definition auto-enter="no" four-digit-year="no" global="no" maxrepeat="1" name="artlocations::Location" not-empty="no" numericonly="no" result="text" time-of-day="no" type="normal"/><field-definition auto-enter="no" four-digit-year="no" global="no" maxrepeat="1" name="artlocations::Date" not-empty="no" numeric-only="no"result="date" time-of-day="no" type="normal"/></relatedset-definition></metadata><resultset count="1" fetch-size="1"><record mod-id="6" record-id="14"><field name="Title"><data>Spring in Giverny 3</data></field><field name="Artist"><data>Claude Monet</data></field><field name="Style"><data/></field><field name="length"><data>19</data></field><relatedset count="0" table="artlocations"/></record></resultset></fmresultset>

Chapter 4 | Accessing XML data with the Web Publishing Engine

33

Using other FileMaker XML grammars
The other FileMaker XML grammars contain information about field types, value lists, and layouts.
FMPXMLRESULT is functionally equivalent to fmresultset. To access value lists and field display
information in layouts, you must use the FMPXMLLAYOUT grammar. The FMPXMLRESULT and
FMPXMLLAYOUT grammars are more compact for data interchange.
To use the FMPXMLRESULT grammar, specify the following grammar name in the URL requesting
the XML document from the Web Publishing Engine:
FMPXMLRESULT.xml

Examplehttp://192.168.123.101/fmi/xml/FMPXMLRESULT.xml?-db=employees&-lay=family&-findall

To use the FMPXMLLAYOUT grammar, specify the following grammar name with the –view querycommand in the URL requesting the XML document from the Web Publishing Engine:
FMPXMLLAYOUT.xml

Examplehttp://192.168.123.101/fmi/xml/FMPXMLLAYOUT.xml?-db=employees&-lay=family&-view

Note When specifying the FMPXMLRESULT and FMPXMLLAYOUT grammars, be sure to enter thegrammar name in uppercase.
In the generated XML document, the Web Publishing Engine will reference the document typedefinition for the grammar in the <!DOCTYPE> instruction in the second line of the document,
immediately after the <?xml...?> instruction. The <!DOCTYPE> instruction specifies the URL for
downloading the DTD for the grammar.

Description of elements in the FMPXMLRESULT grammar
In the FMPXMLRESULT grammar, the <DATABASE> element contains the NAME, RECORDS,DATEFORMAT, LAYOUT, and TIMEFORMAT attributes.
The DATEFORMAT attribute of the <DATABASE> element specifies the format of dates in the XML
document. The TIMEFORMAT attribute of the <DATABASE> element specifies the format of times
in the XML document. The date and time formats for the FMPXMLRESULT and the fmresultset
grammars are the same. See “Description of elements in the fmresultset grammar” on page 30.
The <METADATA> element of the FMPXMLRESULT grammar contains one or more <FIELD>
elements, each containing information for one of the fields/columns of the result set—including thename of the field as defined in the database, the field type, the Yes or No allowance for empty
fields (EMPTYOK attribute) and the maximum number of repeating values (MAXREPEAT
attribute). Valid values for field types are TEXT, NUMBER, DATE, TIME, TIMESTAMP, and
CONTAINER.

Chapter 4 | Accessing XML data with the Web Publishing Engine

34

The <RESULTSET> element contains all of the <ROW> elements returned as the result of a queryand an attribute for the total number of records found. Each <ROW> element contains thefield/column data for one row in the result set. This data includes the RECORDID and MODID forthe row (see “–modid (Modification ID) query parameter” on page 56), and the <COL> element.
The <COL> element contains the data for one field/column in the row where multiple <DATA>
elements represent one of the values in a repeating or portal field.

XML data in the FMPXMLRESULT grammar
Example<FMPXMLRESULT xmlns="http://www.filemaker.com/fmpxmlresult"><ERRORCODE>0</ERRORCODE><PRODUCT BUILD="03/29/2019" NAME="FileMaker Web Publishing Engine"
VERSION="18.0.1.0"/><DATABASE DATEFORMAT="MM/dd/yyyy" LAYOUT="web" NAME="art" RECORDS="12"
TIMEFORMAT="HH:mm:ss"/><METADATA><FIELD EMPTYOK="YES" MAXREPEAT="1" NAME="Title" TYPE="TEXT"/><FIELD EMPTYOK="YES" MAXREPEAT="1" NAME="Artist" TYPE="TEXT"/><FIELD EMPTYOK="YES" MAXREPEAT="1" NAME="Image" TYPE="CONTAINER"/></METADATA><RESULTSET FOUND="1"><ROW MODID="7" RECORDID="4"><COL><DATA>Village Market</DATA></COL><COL><DATA>Camille Pissarro</DATA></COL><COL><DATA>/fmi/xml/cnt/Untitled.pct?-db=art&-lay=web&-recid=4&-field=Image(1)</DATA></COL></ROW></RESULTSET></FMPXMLRESULT>The order of the <COL> elements corresponds with the order of the <FIELD> elements in the<METADATA> element—for example, where the “Title” and “Artist” fields are listed in the<METADATA> element, “Village Market” and then “Camille Pissarro” are listed in the sameorder in the <RESULTSET> and <ROW> elements.

Chapter 4 | Accessing XML data with the Web Publishing Engine

35

Description of elements in the FMPXMLLAYOUT grammar
In the FMPXMLLAYOUT grammar, the <LAYOUT> element contains the name of the layout, thename of the database, and <FIELD> elements for each field found in the corresponding layout inthe database. Each <FIELD> element describes the style type of the field, and contains the
VALUELIST attribute for any associated value list of the field.
The <VALUELISTS> element contains one or more <VALUELIST> elements for each value list
found in the layout—each including the name of the value list and a <VALUE> element for eachvalue in the list.
Depending on the options selected in the Specify Fields for Value List dialog box in the
FileMaker Pro database, the <VALUE> element contains a DISPLAY attribute that contains thevalue in the first field only, the second field only, or both fields of a value list. For example, suppose
the first field in a value list stores the art style’s ID number (such as “100”), and the second field
displays the art style’s associated name (such as “Impressionism”). Here is a summary of thecontents of the DISPLAY attribute when the various combinations of options are selected in theSpecify Fields for Value List dialog box:

1 If Also display values from second field is not selected, the DISPLAY attribute contains thevalue in the first field of a value list only.

ExampleThe DISPLAY attribute contains the art style’s ID number only:<VALUELISTS><VALUELIST NAME="style"><VALUE DISPLAY="100">100</VALUE><VALUE DISPLAY="101">101</VALUE><VALUE DISPLAY="102">102</VALUE></VALUELIST></VALUELISTS>

1 If Also display values from second field and Show values only from second field are both
selected, the DISPLAY attribute contains the value in the second field only.

ExampleThe DISPLAY attribute contains the art style’s name only:<VALUELISTS><VALUELIST NAME="style"><VALUE DISPLAY="Impressionism">100</VALUE><VALUE DISPLAY="Cubism">101</VALUE><VALUE DISPLAY="Abstract">102</VALUE></VALUELIST></VALUELISTS>

Chapter 4 | Accessing XML data with the Web Publishing Engine

36

1 If Also display values from second field is selected and Show values only from second
field is not selected, the DISPLAY attribute contains the values in both fields of a value list.

ExampleThe DISPLAY attribute contains both the art style’s ID number and the art style’s name:<VALUELISTS><VALUELIST NAME="style"><VALUE DISPLAY="100 Impressionism">100</VALUE><VALUE DISPLAY="101 Cubism">101</VALUE><VALUE DISPLAY="102 Abstract">102</VALUE></VALUELIST></VALUELISTS>

For date, time, and timestamp fields, data for value lists are formatted using the “fm” format forthat field type. The “fm” formats are MM/DD/YYYY for date, hh:mm:ss for time, and MM/DD/YYYY
hh:mm:ss for timestamp. For example, if a “birthdays” value list is used for a pop-up menu on a“birthdate” field of a layout, and the “birthdate” field is of type date, then the values output for thatvalue list will all be in the “fm” date format.
Note If two fields with different field types on a layout share the same value list, the first field’s
type determines the format of the value list data.

Chapter 4 | Accessing XML data with the Web Publishing Engine

XML data in the FMPXMLLAYOUT grammar
Example<FMPXMLLAYOUT xmlns="http://www.filemaker.com/fmpxmllayout"><ERRORCODE>0</ERRORCODE><PRODUCT BUILD="03/29/2019" NAME="FileMaker Web Publishing Engine"
VERSION="18.0.1.0"/><LAYOUT DATABASE="art" NAME="web2"><FIELD NAME="Title"><STYLE TYPE="EDITTEXT" VALUELIST=""/></FIELD><FIELD NAME="Artist"><STYLE TYPE="EDITTEXT" VALUELIST=""/></FIELD><FIELD NAME="Image"><STYLE TYPE="EDITTEXT" VALUELIST=""/></FIELD><FIELD NAME="artlocations::Location"><STYLE TYPE="EDITTEXT" VALUELIST=""/></FIELD><FIELD NAME="artlocations::Date"><STYLE TYPE="EDITTEXT" VALUELIST=""/></FIELD><FIELD NAME="Style"><STYLE TYPE="POPUPMENU" VALUELIST="style"/></FIELD></LAYOUT><VALUELISTS><VALUELIST NAME="style"><VALUE DISPLAY="Impressionist">Impressionist</VALUE><VALUE DISPLAY="Modern">Modern</VALUE><VALUE DISPLAY="Abstract">Abstract</VALUE></VALUELIST></VALUELISTS></FMPXMLLAYOUT>

37

Chapter 4 | Accessing XML data with the Web Publishing Engine

38

About UTF-8 encoded data
All XML data generated by the Web Publishing Engine is encoded in UTF-8 (Unicode
Transformation 8 Bit) format. This format compresses data from the standard Unicode format of
16 bits to 8 bits for ASCII characters. XML parsers are required to support Unicode and UTF-8
encoding.
UTF-8 encoding includes direct representations of the values of 0-127 for the standard ASCII set
of characters used in English, and provides multibyte encodings for Unicode characters withhigher values.
Note Be sure to use a web browser or text editor program that supports UTF-8 files.
The UTF-8 encoding format includes the following features:

1 All ASCII characters are one-byte UTF-8 characters. A legal ASCII string is a legal UTF-8 string.
1 Any non-ASCII character (any character with the high-order bit set) is part of a multibyte
character.

1 The first byte of any UTF-8 character indicates the number of additional bytes in the character.
1 The first byte of a multibyte character is easily distinguished from the subsequent byte, whichmakes it is easy to locate the start of a character from an arbitrary position in a data stream.

1 It is easy to convert between UTF-8 and Unicode.
1 The UTF-8 encoding is relatively compact. For text with a large percentage of ASCII characters,
it is more compact than Unicode. In the worst case, a UTF-8 string is only 50% larger than thecorresponding Unicode string.

Using FileMaker query strings to request XML data
To request XML data from a FileMaker Pro database, you use the FileMaker query commands andparameters in a query string.
ExampleYou can use the –findall query command in the following query string in a URL to request
a list of all products in a FileMaker Pro database named “products”:
http://192.168.123.101/fmi/xml/fmresultset.xml?-db=products&-lay=sales&-findall

A query string must contain only one query command, such as –new. Most query commands also
require various matching query parameters in the query string. For example, all query commands
except –dbnames require the –db parameter that specifies the database to query.
You can also use query commands and parameters in a URL.

Chapter 4 | Accessing XML data with the Web Publishing Engine

39

This section contains a summary of the FileMaker query commands and parameters. For
information about using them in a query string, see “Valid names used in XML query strings” onpage 42.
Use this query command nameTo execute this command–dbnames

Retrieve names of all hosted and web-shared databases.

–deleteDelete record.

–dup

Duplicate record.

–edit

Edit record.

–findFind a record or records.

–findallFind all records.

–findany

Find a random record.

–findquery

Perform complex or compound find request.

–layoutnames

Retrieve names of all available layouts for a hosted and web-shared database.

–new

Add new record.

–scriptnames

Retrieve names of all available scripts for a hosted and web-shared database.

–view

Retrieves layout information from a database if the FMPXMLLAYOUT grammar is
specified. Retrieves <metadata> section of XML document and an empty record set
if the fmresultset or FMPXMLRESULT grammar is specified.

Use these query parameter names

With these query commands–db (database name)

Required with all query commands except –dbnames–delete.related

Optional with –edit–fieldRequired to specify a field in a URL for container requests. See “About the URL syntax
for FileMaker Pro container objects in XML solutions” on page 26.

fieldnameAt least one field name is required with –edit. Optional with –find. See “fieldname(Non-container field name) query parameter” on page 52.

fieldname.op (operator)

Optional with –find–lay (layout name)

Required with all query commands, except –dbnames, –layoutnames, and–scriptnames–lay.response (switch layout for XML
response)

Optional with all query commands, except –dbnames, –layoutnames, and–scriptnames–lop (logical operator)

Optional with –find–max (maximum records)

Optional with –find, –findall, and –findquery–modid (modification ID)

Optional with –edit–queryRequired with -findquery compound find requests–recid (record ID)

Required with –edit, –delete, –dup. Optional with –find–relatedsets.filter

Optional with –find, –findall, –findany, –edit, –new, –dup, and –findquery–relatedsets.max

Optional with –find, –edit, –new, –dup, and –findquery–script (perform script)

Optional with –find, –findall, –findany, –new, –edit, –delete, –dup, –view,and –findqueryChapter 4 | Accessing XML data with the Web Publishing Engine

Use these query parameter names

With these query commands–script.param (pass a parameter value
to the script specified by –script)

Optional with –script and –findquery–script.prefind (perform script before–find, –findany, and –findall)

Optional with –find, –findany, –findall, and –findquery–script.prefind.param (pass aparameter value to the script specified by–script.prefind)

Optional with –script.prefind and –findquery–script.presort (perform script before
sort)

Optional with –find, –findall, and –findquery–script.presort.param (pass aparameter value to the script specified by–script.presort)

Optional with –script.presort and –findquery–skip (skip records)

Optional with –find, –findall, and –findquery–sortfield.[1-9] (sort field)

Optional with –find, –findall, and –findquery–sortorder.[1-9] (sort order)

Optional with –find, –findall

40

Switching layouts for an XML response
The –lay query parameter specifies the layout you want to use when requesting XML data. Often,
the same layout is appropriate for processing the data that results from the request. In somecases, you might want to search for data using a layout which contains fields that, for security
reasons, don’t exist in another layout you want to use for displaying the results. (To do a searchfor data in a field, the field must be placed on the layout you specify in the XML request.)
To specify a different layout for displaying an XML response than the layout used for processing
the XML request, you can use the optional –lay.response query parameter.
ExampleThe following request searches for values greater than 100,000 in the “Salary” field on the“Budget” layout. The resulting data is displayed using the “ExecList” layout, which does notinclude the “Salary” field.
http://192.168.123.101/fmi/xml/fmresultset.xml?-db=employees&-lay=Budget&Salary=100000&Salary.op=gt&-find&-lay.response=ExecList

Chapter 4 | Accessing XML data with the Web Publishing Engine

41

Understanding how an XML request is processed
There are several query parameters that affect the processing of an XML request and thegeneration of an XML document.
Here is the order in which FileMaker Server and the Web Publishing Engine process an XML
request:1. Process the –lay query parameter.
2. Set the global field values specified in the query (the “.global=” portion of a URL).
3. Process the –script.prefind query parameter, if specified.
4. Process the query commands, such as –find or –new.
5. Process the –script.presort query parameter, if specified.
6. Sort the resulting data, if a sort was specified.
7. Process the –script query parameter, if specified.
8. Process the –lay.response query parameter to switch to a different layout, if this is specified.
9. Generate the XML document.
If one of the above steps generates an error code, the request processing stops; any steps that
follow are not executed. However, any prior steps in the request are still executed.
For example, consider a request that deletes the current record, sorts the records, and thenexecutes a script. If the –sortfield parameter specifies a nonexistent field, the request deletes
the current record and returns error code 102 (“Field is missing”), but does not execute the script.

Troubleshooting XML document access
If you have trouble accessing XML documents with the Web Publishing Engine, verify that:

1 The extended privileges in the database are set for XML Custom Web Publishing and assigned
to a user account. See “Enabling Custom Web Publishing in a database” on page 13.

1 The database is hosted on the Database Server component of the FileMaker Server
deployment, and is opened by FileMaker Server. See FileMaker Server Help.

1
1
1
1

The database account name and password you are using, if any, are correct.
The web server component of the FileMaker Server deployment is running.
The Web Publishing Engine component of the FileMaker Server deployment is running.
XML Publishing is enabled using the CLI. See FileMaker Server Help.

Chapter 5
Valid names used in XML query strings
This chapter describes the valid names of query commands and parameters you can use in an
XML query string when accessing FileMaker data using the Web Publishing Engine.

About the query commands and parameters
The following is a complete list of the query command names and query parameter names:
Query command names

Query parameter names–dbnames (See page 47.)–delete (See page 47.)
–dup (See page 48.)
–edit (See page 48.)–find, –findall, –findany (See page 49.)
–findquery (See page 49.)
–layoutnames (See page 50.)
–new (See page 50.)
–scriptnames (See page 51.)
–view (See page 51.)–db (See page 51.)
–field (See page 52.)
fieldname (See page 52.)
fieldname.op (See page 53.)
–lay (See page 54.)
–lay.response (See page 54.)–lop (See page 55.)
–max (See page 55.)
–modid (See page 56.)
–query (See page 56.)
–recid (See page 57.)
–relatedsets.filter (See page 58.)
–relatedsets.max (See page 59.)
–script (See page 59.)
–script.param (See page 60.)
–script.prefind (See page 60.)
–script.prefind.param (See page 60.)
–script.presort (See page 61.)
–script.presort.param (See page 61.)
–skip (See page 62.)
–sortfield.[1-9] (See page 62.)
–sortorder.[1-9] (See page 63.)

Important The –lay parameter for specifying a layout is required with all query commands
except –dbnames, –layoutnames, and –scriptnames.

Chapter 5 | Valid names used in XML query strings

43

Guidelines for using query commands and parameters
When using query commands and parameters in a query string, keep the following guidelines inmind:

1 A query string must contain only one query command; no more and no less. For example, aquery string can contain –new to add a new record, but it can’t contain –new and –edit in thesame query string.

1 Most query commands require various matching query parameters in the query string. For

example, all query commands except –dbnames require the –db parameter that specifies the
database to query. See the table of required parameters in “Using FileMaker query strings torequest XML data” on page 38.

1 For query parameters and field names, specify the particular value you want to use, such as-db=employees. For query commands, don’t specify an “=” sign or a value after the command
name, such as –findall.

1 The Web Publishing Engine converts all reserved words to lowercase, including querycommands, query parameters, and command values where specific values are expected (forexample: –lop=and, –lop=or, –sortorder=ascend, –sortorder=descend,–max=all).

1 Database names, layout names, and field names used in query strings are case insensitive,
such as using –lay=mylayout to specify the layout name MyLayout.

1 It is not recommended to use periods or parentheses in field names. In some cases, field nameswith periods may work, but field names with the following exceptions can never be used:

1 The period cannot be followed by a number. For example, myfield.9 is an invalid fieldname.

1 The period cannot be followed by the text string op (the two letters “op”). For example,
myfield.op is an invalid field name.

1 The period cannot be followed by the text string global (the word “global”). For example,
myfield.global is an invalid field name.

Field names containing any of these exceptions cannot be accessed via XML using an HTTP
query. These constructs are reserved for record IDs, as described in the section, “About thesyntax for a fully qualified field name” on page 45.

1 For the –find command, the value of a field is case insensitive. For example, you can use

Field1=Blue or Field1=blue. For the –new and –edit commands, the case you use in
the value of a field is preserved and stored in the database exactly as you specify in the query
string. For example, LastName=Doe.

Chapter 5 | Valid names used in XML query strings

44

Query command parsing
The Web Publishing Engine parses query commands in the following order, and stops parsing
XML queries with the first error. If an error code is returned, the error code returned matches thefirst error that is identified.
1. Does the query have a command and is the query command valid?
It is an error if the query is missing the command or uses an unknown command.
Example-database
2. Does the query have two commands?
Example-find&-edit
3. Does the query have an invalid value for a command or parameter?
Example-lop=amd
4. Is the query missing the required database name parameter (–db parameter)?
5. Is the query missing the required layout name parameter (–lay parameter)?
6. Does the query have an invalid sort?
7. Does the query have invalid field parameters?
Note If a query contains valid but extraneous information, the query is processed without anerror. For example, if you specify the –lop parameter on a –delete command, the –lopparameter is ignored because it does not cause the query to be invalid or ambiguous.
For information about specific error codes returned, see appendix A, “Error codes for Custom Web
Publishing.”

Chapter 5 | Valid names used in XML query strings

45

About the syntax for a fully qualified field name
A fully qualified field name identifies an exact instance of a field. Because fields with common
names can be based on different tables, you must use fully qualified names, in some cases, toavoid errors.
The syntax for specifying a fully qualified field name is:table-name::field-name(repetition-number).record-id
where:

1 table-name is the name of the table that contains the field. The table name is only required if
the field is not in the underlying table of the layout specified in the query string.

1 field-name(repetition-number) is the specific value in a repeating field, and is only

required for repeating fields. The repetition number starts counting at the numeral 1. For
example, field-name(2) refers to the second value in the repeating field. If you don’t specify
a repetition number for a repeating field, the first value in the repeating field is used. The
repetition-number is required for the –new and –edit query commands involving repeating
fields, but it is not required for the –find command.

1 record-id is the record ID, and is only required if you are using a query string to add or edit
records in portal fields. See the following sections “Adding records to a portal” and “Editing
records in a portal.” The record-id is required for the –new and –edit query commands
involving portal fields, but it is not required for the –find command.

Note To be accessible, fields must be placed on the layout you specify in the query string.

Using query commands with portal fields
The following sections describe how query commands work with portal fields.
Adding records to a portal
To add a new record to a portal at the same time you add a parent record, use the –new querycommand and do the following in query string for the request:

1
1
1
1

Use the fully qualified field name for the related portal field.
Specify 0 as the record ID after the name of the related portal field.
Specify at least one of the fields for the parent record before specifying the related portal field.
Specify the data for the match field (key field) in the parent record.

ExampleThe following URL adds a new parent Employee record for John Doe, and a new related
record for Jane in the portal at the same time. The name of the related table is Dependents,
and the name of the related field in the portal is Names. The match field, ID, stores an
employee ID number.
http://192.168.123.101/fmi/xml/fmresultset.xml?-db=employees&-lay=family&FirstName=John&LastName=Doe&ID=9756&Dependents::Names.0=Jane&-new

Note You can only add one related record to a portal per request.

Chapter 5 | Valid names used in XML query strings

46

Editing records in a portal
To edit one or more records in a portal, use the –edit command and a record ID to specify theparent record that contains the portal records you want to edit. Specify the particular portal record
to edit by using its record ID in a fully qualified field name. You can determine a record ID from therecord ID attribute of the <record> element in the <relatedset> element in the XML data. See“Using the fmresultset grammar” on page 29.
ExamplesThe following URL edits a record in a portal where the parent record has the record ID of 1001.
Dependents is the name of the related table, Names is the name of the related field in the
portal, and the 2 in Names.2 is the record ID of a portal record.
http://192.168.123.101/fmi/xml/fmresultset.xml?-db=employees&-lay=family&-recid=1001&Dependents::Names.2=Kevin&-edit

How to use one request to edit multiple portal records via the parent record:
http://192.168.123.101/fmi/xml/fmresultset.xml?-db=employees&-lay=family&-recid=1001&Dependents::Names.2=Kevin&Dependents::Names.5=Susan&-edit

You can also use the –edit command and specify 0 as the portal record ID to add a new
related record in the portal for an existing parent record.
http://192.168.123.101/fmi/xml/fmresultset.xml?-db=employees&-lay=family&-recid=1001&Dependents::Names.0=Timothy&-edit

Deleting portal records
To delete portal records, use the –delete.related parameter with the –edit command rather
than using the –delete command.
ExamplesThe following URL deletes record “1001” from the table “employees”:
http://192.168.123.101/fmi/xml/fmresultset.xml?-db=employees&-lay=family&-recid=1001&-delete

But the following URL deletes a portal record with a record ID of “3” from the related tablecalled “Dependents”, with the parent record ID of “1001”.
http://192.168.123.101/fmi/xml/fmresultset.xml?-db=employees&-lay=family&-recid=1001&-delete.related=Dependents.3&-edit

See “–delete.related (Portal records delete) query parameter” on page 52.
Querying portal fields
In a solution that has many related records, querying and sorting portal records can be time
consuming. To restrict the number of records and rows to display in a related set, use the–relatedsets.filter and –relatedsets.max parameters with find requests. See“–relatedsets.filter (Filter portal records) query parameter” on page 58 and “–relatedsets.max(Limit portal records) query parameter” on page 59.

Chapter 5 | Valid names used in XML query strings

47

About the syntax for specifying a global field
The syntax for specifying a global field is:table-name::field-name(repetition-number).global
where global identifies a field as using global storage. For information about table-name andfield-name(repetition-number), see “About the syntax for a fully qualified field name” onpage 45. For information on global fields, see FileMaker Pro Help.
You must use the .global syntax to identify a global field in a query string. The Web Publishing
Engine sets the parameter values for global fields before performing the query command or setting
any other parameter values in the query string. For direct XML requests, the global values expire
immediately after the request is made.
If you don’t use the .global syntax to identify a global field in a query string, the Web Publishing
Engine evaluates the global field along with the remainder of the query string without setting the
global field value first.
Examplehttp://192.168.123.101/fmi/xml/fmresultset.xml?-db=employees&-lay=departments&Country.global=USA&-recid=1&-edit

Query command referenceThis section contains information about the query commands available for XML requests.

–dbnames (Database names) query command
Retrieves the names of all databases that are hosted by FileMaker Server and enabled for Custom
Web Publishing with XML.
Required query parameters: (none)
ExampleTo retrieve the database names:
http://192.168.123.101/fmi/xml/fmresultset.xml?-dbnames–delete (Delete record) query command
Deletes the record specified by the –recid parameter.
Required query parameters: –db, –lay, –recid
Optional query parameter: –script
ExampleTo delete a record:
http://192.168.123.101/fmi/xml/fmresultset.xml?-db=employees&-lay=departments&-recid=4&-delete

Chapter 5 | Valid names used in XML query strings

48–dup (Duplicate record) query command
Duplicates the record specified by the –recid parameter.
Required query parameters: –db, –lay, –recid
Optional query parameter: –script
ExampleTo duplicate the specified record:
http://192.168.123.101/fmi/xml/fmresultset.xml?-db=employees&-lay=departments&-recid=14&-dup–edit (Edit record) query command
Updates the record specified by the –recid parameter, populating the fields with the contents ofany field name/value pairs. The –recid parameter indicates which record should be edited.
Required query parameters: –db, –lay, –recid, one or more field name(s)Optional query parameter: –modid, –script, field nameNote The –edit command can be used for editing records in a portal. See “Editing records in a
portal” on page 46.
ExampleTo edit a record:
http://192.168.123.101/fmi/xml/fmresultset.xml?-db=employees&-lay=departments&-recid=13&Country=USA&-edit

Chapter 5 | Valid names used in XML query strings

49–find, –findall, or –findany (Find records) query commands
Submits a search request using defined criteria.
Required query parameters: –db, –lay
Optional query parameters: –recid, –lop, –op, –max, –skip, –sortorder, –sortfield,–script, –script.prefind, –script.presort, field nameExamplesTo find a record by field name:http://192.168.123.101/fmi/xml/fmresultset.xml?-db=employees&-lay=family&Country=USA&-findTo find a record by record ID:
http://192.168.123.101/fmi/xml/fmresultset.xml?-db=employees&-lay=family&-recid=427&-findTo find all records in the database, use –findall:
http://192.168.123.101/fmi/xml/fmresultset.xml?-db=employees&-lay=family&-findallTo find a random record, use –findany:
http://192.168.123.101/fmi/xml/fmresultset.xml?-db=employees&-lay=family&-findanyNotes

1 Specifying a field name multiple times in a single request is not supported; FileMaker Serverparses all of the values, but uses only the last value parsed.

1 When using the –findall command, avoid computer memory overload problems by

specifying a default maximum number of records to return per page by using the –max queryparameter.

–findquery (Compound find) query command
Submits a search request using multiple find records and omit records requests.
Required query parameters: –db, –lay, –query
Optional query parameters: –max, –skip, –sortorder, –sortfield, –script,–script.prefind, –script.presort
ExampleFind records for cats or dogs that are not named “Fluffy”:
http://host/fmi/xml/fmresultset.xml?-db=vetclinic&-lay=animals&-query=(q1);(q2);!(q3)&-q1=typeofanimal&-q1.value=Cat&-q2=typeofanimal&-q2.value=Dog&-q3=name&-q3.value=Fluffy&-findqueryChapter 5 | Valid names used in XML query strings

50

Using the -findquery command for compound finds
A –findquery statement consists of four parts, in the following order:

1 The –query parameter.
1 The query request declarations, consisting of the query identifier declarations and request
operations.

1 The search field and value definitions for each query identifier.
1 Define query identifiers. A query identifier is the letter "q" followed by a number. For example:-q1

1 Define query identifier values with the parameter. For example: -q1.value=fieldvalue
1 Define query identifier operators by including it as part of the fieldvalue expression. For
example, to use an asterisk as a “begins with” operator: -q1.value=fieldvalue*

1 The –findquery command, at the end of the complete statement.
For information on using the –query parameter, see “–query (Compound find request) queryparameter” on page 56.

–layoutnames (Layout names) query command
Retrieves the names of all available layouts for a specified database that is hosted byFileMaker Server and enabled for Custom Web Publishing with XML.
Required query parameters: –db
ExampleTo retrieve the names of available layouts:
http://192.168.123.101/fmi/xml/fmresultset.xml?-db=employees&-layoutnames–new (New record) query command
Creates a new record and populates that record with the contents of any field name/value pairs.
Required query parameters: –db, –lay
Optional query parameter: one or more field name(s), –script
Note For information on including new data for a portal, see “Adding records to a portal” onpage 45.
ExampleTo add a new record:
http://192.168.123.101/fmi/xml/fmresultset.xml?-db=employees&-lay=departments&Country=Australia&-newChapter 5 | Valid names used in XML query strings

51–scriptnames (Script names) query command
Retrieves the names of all available scripts for a specified database that is hosted byFileMaker Server and enabled for Custom Web Publishing with XML.
Required query parameters: –db
ExampleTo retrieve the names of all scripts:
http://192.168.123.101/fmi/xml/fmresultset.xml?-db=employees&-scriptnames–view (View layout information) query command
If the FMPXMLLAYOUT grammar is specified, retrieves layout information from a database anddisplays it in the FMPXMLLAYOUT grammar. If a data grammar (fmresultset or
FMPXMLRESULT) is specified, retrieves the metadata section of XML document and an empty
record set.
Required query parameters: –db, –lay
Optional query parameter: –script
ExamplesTo retrieve layout information:
http://192.168.123.101/fmi/xml/FMPXMLLAYOUT.xml?-db=employees&-lay=departments&-view

To retrieve metadata information:
http://192.168.123.101/fmi/xml/fmresultset.xml?-db=employees&-lay=departments&-view

Query parameter referenceThis section contains information about the query parameters available for XML requests.

–db (Database name) query parameter
Specifies the database that the query command is applied to.
Value is: Name of the database, not including the filename extension if any.
Note When specifying the name of the database for the –db parameter in query strings, do notinclude a filename extension. The actual database filename can optionally include an extension,but extensions are not allowed as a value for the –db parameter.
Required with: All query commands except –dbnames
Examplehttp://192.168.123.101/fmi/xml/fmresultset.xml?-db=employees&-lay=departments&-findall

Chapter 5 | Valid names used in XML query strings

52–delete.related (Portal records delete) query parameter
Deletes a record from a portal field.
Optional with: –edit query command
Requires: A related table name and a record id
ExampleThe following deletes a portal record with a record ID of “20” from the related table called“jobtable”, with a parent record ID of “7”.
http://host/fmi/xml/fmresultset.xml?-db=career&-lay=applications&-recid=7&-delete.related=jobtable.20&-edit–field (Container field name) query parameter
Specifies the name of a container field.
Required with: Requests for data in a container fieldSee “About the URL syntax for XML data and container objects” on page 25.

fieldname (Non-container field name) query parameter
Field names are used to control criteria for the –find query command, or to modify the contents
of a record. When you need to specify a value for a non-container field for a query command or
parameter, use the field name without the hyphen (-) character as the name portion of thename/value pair.
Name is: Name of the field in the FileMaker Pro database. If the field is not in the underlying tableof the layout specified in the query string, the field name must be fully qualified.
It is not recommended to use periods or parentheses in field names. In some cases, field nameswith periods may work, but field names with the following exceptions can never be used:

1 The period cannot be followed by a number. For example, myfield.9 is an invalid fieldname.

1 The period cannot be followed by the text string op (the two letters “op”). For example,
myfield.op is an invalid field name.

1 The period cannot be followed by the text string global (the word “global”). For example,
myfield.global is an invalid field name.

Field names containing any of these exceptions cannot be accessed via XML using an HTTP
query. Using periods in field names should be reserved for record IDs, as described in “About thesyntax for a fully qualified field name” on page 45.
Value is: For the –new and –edit query commands, specify the value you want to store in thefield in the current record. For the –find query commands, specify the value you want to search
for in the field. When you specify the value for a date, time, or timestamp field, specify the value
using the “fm” format for that field type. The “fm” formats are MM/DD/YYYY for date, hh:mm:ss fortime, and MM/DD/YYYY hh:mm:ss for timestamp.
Required with: –edit query command
Optional with: –new and –find query commands

Chapter 5 | Valid names used in XML query strings

Examplehttp://192.168.123.101/fmi/xml/fmresultset.xml?-db=employees&-lay=departments&-op=eq&FirstName=Sam&-max=1&-findNote Specifying a field name multiple times in a single request is not supported;
FileMaker Server parses all of the values, but uses only the last value parsed.

fieldname.op (Comparison operator) query parameter
Specifies the comparison operator to apply to the field name that precedes the operator.
Comparison operators are used with the –find query command.
Value is: The operator you want to use. Valid operators are as follows:
Keyword

FileMaker Pro equivalent operator

eq

=word

cn

*word*

bw

word*

ew

*word

gt

> wordgte>= wordlt< wordlte<= wordneqomit, word

Optional with: –find query command
Requires: A field name and a value
The syntax for specifying a comparison operator is:table-name::field-name=value&table-name::field-name.op=op-symbol
where:

1 table-name is the table that contains the field and is only required if the field is not in thesource table of the layout specified in the query string.

1 op-symbol is one of the keywords in the preceding table, such as cn.
Examplehttp://192.168.123.101/fmi/xml/fmresultset.xml?-db=employees&-lay=departments&name=Tim&name.op=cn&-findNote The bw keyword does not work with date, time, or timestamp strings, or with the current
date (//) find operator.

53

Chapter 5 | Valid names used in XML query strings

54

You can use any FileMaker Pro find operator by including it as part of the search criteria insteadof specifying the fieldname.op operator keyword. For example, to find a range of values using therange (...) find operator, do not specify any operator keyword. Instead, use the characters “...”between the range values in the search criteria.
Examplehttp://192.168.123.101/fmi/xml/fmresultset.xml?-db=employees&-lay=departments&IDnum=915...925&-find

For information on the operators you can use to find text, see FileMaker Pro Help.

–lay (Layout) query parameter
Specifies the database layout you want to use.
Value is: Name of the layout
Required with: All query commands except –dbnames, –layoutnames, and –scriptnames
Examplehttp://192.168.123.101/fmi/xml/fmresultset.xml?-db=employees&-lay=departments&-view–lay.response (Switch layout for response) query parameter
Specifies that FileMaker Server should use the layout specified by the –lay parameter whenprocessing a request, and switch to the layout specified by the –lay.response parameter whenprocessing the XML response.
If you don’t include the –lay.response parameter, FileMaker Server uses the layout specified
by the –lay parameter when processing both the request and the response.
You can use the –lay.response parameter for XML requests.
Value is: Name of the layout
Optional with: All query commands except –dbnames, –layoutnames, and –scriptnames.
Examplehttp://192.168.123.101/fmi/xml/fmresultset.xml?-db=employees&-lay=Budget&Salary=100000&Salary.op=gt&-find&-lay.response=ExecList

Chapter 5 | Valid names used in XML query strings

55–lop (Logical operator) query parameter
Specifies how the find criteria in the –find query command are combined as either an “and” oran “or” search.
Value is: and or orIf the –lop query parameter is not included, then the –find query command uses the “and” value.
Optional with: –find query command
Note Not supported by -findquery query command.
Examplehttp://192.168.123.101/fmi/xml/fmresultset.xml?-db=employees&-lay=departments&Last+Name=Smith&Birthdate=2/5/1972&-lop=and&-find–max (Maximum records) query parameter
Specifies the maximum number of records you want returned.
Value is: A number, or use the value all to return all records. If –max is not specified, all records
are returned.
Optional with: –find, –findall, and -findquery query commands
Note The –max query parameter does not affect the values returned for portal records. To limit
the number of rows returned for portal records, see “–relatedsets.max (Limit portal records) queryparameter” on page 59.
Examplehttp://192.168.123.101/fmi/xml/fmresultset.xml?-db=employees&-lay=departments&-max=10&-findall
http://192.168.123.101/fmi/xml/fmresultset.xml?-db=employees&-lay=departments&-max=all&-findall

Chapter 5 | Valid names used in XML query strings

56–modid (Modification ID) query parameter
The modification ID is an incremental counter that specifies the current version of a record. By
specifying a modification ID when you use an –edit query command, you can make sure thatyou are editing the current version of a record. If the modification ID value you specify does notmatch the current modification ID value in the database, the –edit query command is not allowed
and an error code is returned.
Value is: A modification ID, which is a unique identifier for the current version of a record in a
FileMaker Pro database.
Optional with: –edit query command
Requires: –recid parameter
Examplehttp://192.168.123.101/fmi/xml/fmresultset.xml?-db=employees&-lay=departments&-recid=22&-modid=6&last_name=Jones&-edit–query (Compound find request) query parameter
Specifies the query names and search criteria for a compound find request. See “–findquery(Compound find) query command” on page 49.
Value is: A query expression.
Required with: –findquery query command
The syntax for a compound find request is:-query=<request-declarations><request-definitions>&-findquery

where:<request-declarations> is two or more request declarations.

1 Each request declaration is composed of one or more query identifiers separated by commas,
and enclosed in parentheses. A query identifier is the letter “q” followed by a number. For
example: q1

1 Enclosed in parentheses, the multiple queries act as logical AND searches that narrow thefound set. For example, (q1, q2) returns records that match q1 and q2.

Note It is not recommended to use the same fields for multiple q variables in the same “and”
search criteria.

1 As with FileMaker Pro, each request can be either a find request or an omit request. A findrequest adds the matching records to the found set; an omit request removes the matchingrecords from the found set. The default is a find request. For an omit request, put an
exclamation point (!) in front of the opening parenthesis.
Example(q1);!(q2)

q1 is a find request; q2 is an omit request because it is preceded by an exclamation point.

Chapter 5 | Valid names used in XML query strings

57

1 Requests are separated by semicolons. Multiple find requests act as logical OR searches thatbroaden the found set. For example, (q1);(q2) returns records that match q1 or q2. Omit
requests do not act as logical OR searches because omit requests remove records from thefound set.

1 Requests are executed in the order specified; the found set includes the results of the entire
compound find request.

<request-definitions> is a request definition for each request declaration. Each request
definition consists of a search field and value definition. A minus (-) sign starts the request
definition.
Syntax:-<query-id>=<fieldname>&-<query-id>.value=<value>
Examples-q1=typeofanimal&-q1.value=Cat-q2=name&-q2.value=Fluffy

Find records of gray cats that are not named “Fluffy”:
http://host/fmi/xml/fmresultset.xml?-db=petclinic&-lay=Patients&-query=(q1, q2);!(q3)&-q1=typeofanimal&-q1.value=Cat&-q2=color&-q2.value=Gray&-q3=name&-q3.value=Fluffy&-findquery–recid (Record ID) query parameter
Specifies the record you want processed. Used mainly by the –edit, and –delete querycommands. Used by the –view command to retrieve related value list data in the
FMPXMLLAYOUT grammar.
Value is: A record ID, which is a unique specifier to a record in a FileMaker Pro database
Required with: –edit, –delete, and –dup query commands
Optional with: –find query and –view commands
Examples
http://192.168.123.101/fmi/xml/fmresultset.xml?-db=employees&-lay=departments&-recid=22&-delete
http://localhost/fmi/xml/FMPXMLLAYOUT.xml?-db=test&-lay=empty&-view&-recid=9

Chapter 5 | Valid names used in XML query strings

58–relatedsets.filter (Filter portal records) query parameter
Specifies whether to limit the portal records to be returned in the results for this query.
Value is: layout or none

1 If –relatedsets.filter is set to layout, then the Initial row setting specified in the
FileMaker Pro Portal Setup dialog box is respected.

1 If the Allow vertical scrolling setting is enabled in the Portal Setup dialog box, then use the–relatedsets.max option to specify the maximum number of records to be returned. See“–relatedsets.max (Limit portal records) query parameter” below.

1 If the Allow vertical scrolling setting is disabled or the –relatedsets.max option is not
used, then the Number of rows setting in the Portal Setup dialog box determines thenumber of portal records to be returned.

1 The default value is none if this parameter is not specified. If –relatedsets.filter is set

to none, then the Web Publishing Engine returns all records in the portal. The values for Initial
row and Number of rows specified in the Portal Setup dialog box are ignored.

Notes

1 The –relatedsets.filter parameter has no impact on how portal records are sorted in
XML queries. The sort specified in FileMaker Pro is respected whether the–relatedsets.filter parameter value is layout or none.

1 The Filter portal records setting in the Portal Setup dialog box is not supported for XML
queries. Any calculation specified for the Filter portal records setting is ignored.

Optional with: –find, –edit, –new, –dup, and –findquery.
Examples
http://localhost/fmi/xml/fmresultset.xml?-db=FMPHP_Sample&-lay=English&-relatedsets.filter=none&-findany
http://localhost/fmi/xml/fmresultset.xml?-db=FMPHP_Sample&-lay=English&relatedsets.filter=layout&-relatedsets.max=all&-findany
http://localhost/fmi/xml/fmresultset.xml?-db=FMPHP_Sample&-lay=English&-relatedsets.filter=layout&-relatedsets.max=10&-findany

Chapter 5 | Valid names used in XML query strings

59–relatedsets.max (Limit portal records) query parameter
Specifies the maximum number of portal records to return in the results for this query.
Value is: an integer, or all.

1 The –relatedsets.max parameter is respected only if the Allow vertical scrolling setting
is enabled in the FileMaker Pro Portal Setup dialog box and the –relatedsets.filter
parameter is layout.

1 If the –relatedsets.max parameter specifies an integer, then the Web Publishing Engine
returns that number of portal records starting with the initial row.

1 If the –relatedsets.max parameter specifies all, then the Web Publishing Engine
returns all portal records.

Note For information on filtering portal records, see “–relatedsets.filter (Filter portal records)
query parameter” above.
Optional with: –find, –edit, –new, –dup, and –findquery.
Examples
http://localhost/fmi/xml/fmresultset.xml?-db=FMPHP_Sample&-lay=English&relatedsets.filter=layout&-relatedsets.max=all&-findany
http://localhost/fmi/xml/fmresultset.xml?-db=FMPHP_Sample&-lay=English&-relatedsets.filter=layout&-relatedsets.max=10&-findany–script (Script) query parameter
Specifies the FileMaker script to run after the query command and sorting are executed. See“Understanding how an XML request is processed” on page 41.
Value is: Script name
Optional with: All query commands except –dbnames, –layoutnames, and –scriptnames
Examplehttp://192.168.123.101/fmi/xml/fmresultset.xml?-db=employees&-lay=departments&-script=myscript&-findall

Chapter 5 | Valid names used in XML query strings

60–script.param (Pass parameter to Script) query parameter
Passes a parameter to the FileMaker script specified by –script.
Value is: A single text parameter.

1 To pass in multiple parameters, you can create a string delimiting the parameters and have yourscript parse out the individual parameters. For example, pass “param1|param2|param3” asa list with the “|” character URL-encoded as this: param1%7Cparam2%7Cparam3

1 To treat the text parameter as a value that is not text, your script can convert the text value. For
example, to convert the text value to a number, your script could include the following:
GetAsNumber(Get(ScriptParam))

1 If your query contains –script.param without –script, then –script.param is ignored.
1 If your query contains more than one –script.param, then the Web Publishing Engine uses
the last value that it parses.

Optional with: –script
Examplehttp://192.168.123.101/fmi/xml/fmresultset.xml?-db=employees&-lay=departments&-script=myscript&-script.param=Smith%7CChatterjee%7CSu&-findall–script.prefind (Script before Find) query parameter
Specifies the FileMaker script to run before finding and sorting of records (if specified) during
processing of the –find query command.
Value is: Script name
Optional with: All query commands except –dbnames, –layoutnames, and –scriptnames
Examplehttp://192.168.123.101/fmi/xml/fmresultset.xml?-db=employees&-lay=departments&-script.prefind=myscript&-findall–script.prefind.param (Pass parameter to Script before Find) query parameter
Passes a parameter to the FileMaker script specified by –script.prefind.
Value is: A single text parameter.

1 To pass in multiple parameters, you can create a string delimiting the parameters and have yourscript parse out the individual parameters. For example, pass “param1|param2|param3” asa list with the “|” character URL-encoded as this: param1%7Cparam2%7Cparam3

1 To treat the text parameter as a value that is not text, your script can convert the text value. For
example, to convert the text value to a number, your script could include the following:
GetAsNumber(Get(ScriptParam))

1 If your query contains –script.prefind.param without –script.prefind, then–script.prefind.param is ignored.

Chapter 5 | Valid names used in XML query strings

61

1 If your query contains more than one –script.prefind.param, then the Web Publishing
Engine uses the last value that it parses.

Optional with: –script.prefind
Examplehttp://192.168.123.101/fmi/xml/fmresultset.xml?-db=employees&-lay=departments&-script.prefind=myscript&-script.prefind.param=payroll&-findall–script.presort (Script before Sort) query parameter
Specifies the FileMaker script to run after finding records (if specified) and before sorting records
during processing of the –find query command.
Optional with: All query commands except –dbnames, –layoutnames, and –scriptnames
Examplehttp://192.168.123.101/fmi/xml/fmresultset.xml?-db=employees&-lay=departments&-script.presort=myscript&-sortfield.1=dept&-sortfield.2=rating&-findall–script.presort.param (Pass parameter to Script before Sort) query parameter
Passes a parameter to the FileMaker script specified by –script.presort.
Value is: A single text parameter.

1 To pass in multiple parameters, you can create a string delimiting the parameters and have yourscript parse out the individual parameters. For example, pass “param1|param2|param3” asa list with the “|” character URL-encoded as this: param1%7Cparam2%7Cparam3

1 To treat the text parameter as a value that is not text, your script can convert the text value. For
example, to convert the text value to a number, your script could include the following:
GetAsNumber(Get(ScriptParam))

1 If your query contains –script.presort.param without –script.presort, then–script.presort.param is ignored.

1 If your query contains more than one –script.presort.param, then the Web Publishing
Engine uses the last value that it parses.

Optional with: –script.presort
Examplehttp://192.168.123.101/fmi/xml/fmresultset.xml?-db=employees&-lay=departments&-script.presort=myscript&-script.presort.param=18%7C65&-sortfield.1=dept&-sortfield.2=rating&-findall

Chapter 5 | Valid names used in XML query strings

62–skip (Skip records) query parameter
Specifies how many records to skip in the found set.
Value is: A number. If the value is greater than the number of records in the found set, then norecord is displayed. The default value is 0.
Optional with: –find query command
ExampleThe first 10 records in the found set are skipped and records 11 through 15 are returned:
http://192.168.123.101/fmi/xml/fmresultset.xml?-db=employees&-lay=departments&-skip=10&-max=5&-findall–sortfield (Sort field) query parameter
Specifies the field to use for sorting.
Value is: field name
Optional with: –find or –findall query commands
The –sortfield query parameter can been used multiple times to perform multiple field sorts.
The syntax for specifying the precedence of the sort fields is:-sortfield.precedence-number=fully-qualified-field-namewhere the precedence-number in the –sortfield.precedence-number query parameteris a number that specifies the precedence to use for multiple sort fields. The value forprecedence-number:

1 must start from 1
1 must increment sequentially
1 must not be greater than 9
ExampleThe “dept” field is sorted first, and then the “rating” field is sorted. Both fields are sorted inascending order because the –sortorder query parameter is not specified.
http://192.168.123.101/fmi/xml/fmresultset.xml?-db=employees&-lay=performance&-sortfield.1=dept&-sortfield.2=rating&-findall

Chapter 5 | Valid names used in XML query strings

63–sortorder (Sort order) query parameter
Indicates the direction of a sort.
Value is: The sort order. Valid sort orders are as follows, where <value-list-name> is a value
list name such as Custom:
Keyword

FileMaker Pro Equivalent Operator

ascendSort a to z, -10 to 10

descend

Sort z to a, 10 to -10<value-list-name>

Sort using the specified value list associated with the field on the layout

Optional with: –find or –findall query commands
Requires: –sortfield query parameter
The –sortorder query parameter can been used with the –sortfield query parameter tospecify the sort order of multiple sort fields. The syntax for specifying the sort order of a sort field is:-sortorder.precedence-number=sort-method

where:

1 precedence-number in the –sortorder.precedence-number parameter is a number
from 1 to 9 that specifies the –sortfield query parameter that the –sortorder queryparameter applies to

1 sort-method is one of the keywords in the preceding table to specify the sort order, such as
ascendExampleThe sort order of the highest precedence sort field (dept) is ascend, and the sort order of thesecond highest precedence sort field (rating) is descend. The precedence-number 2 in sortorder.2 specifies that the query parameter -sortorder.2=descend applies to the-sortfield.2=rating query parameter.
http://192.168.123.101/fmi/xml/fmresultset.xml?-db=employees&-lay=performance&-sortfield.1=dept&-sortorder.1=ascend&-sortfield.2=rating&-sortorder.2=descend&-findall

Note If a –sortorder query parameter is not specified for a sort field, the default ascending sort
is used.

Chapter 6
About Custom Web Publishing with PHP
Custom Web Publishing with PHP lets you use the PHP scripting language to integrate data from
FileMaker Pro databases with your customized webpage layouts. Custom Web Publishing with
PHP provides the FileMaker API for PHP, which is a PHP class that accesses databases hosted
by FileMaker Server. This PHP class connects to the FileMaker Server Web Publishing Engine
and makes data available to your web server’s PHP engine.

Key features in Custom Web Publishing with PHP
1 Create web applications that use the Open Source PHP scripting language. Use theFileMaker Server supported version of PHP, or use your own version of PHP. (If you decide touse your own version of PHP, see “Manually installing the FileMaker API for PHP” on page 66.)

1 Host databases on FileMaker Server. FileMaker Pro is not required for Custom Web Publishing
because FileMaker Server hosts the databases.

1 Write PHP code that can create, delete, edit, and duplicate records in a hosted FileMaker Pro
database. Your code can perform field and record validation before committing changes backto the hosted database.

1 Write PHP code that accesses layouts, portals, value lists, and related fields. Like

FileMaker Pro, access to data, layouts, and fields is based on the user account settings definedin the database’s access privileges. The Web Publishing Engine also supports several othersecurity enhancements. See “Protecting your published databases” on page 14.

1 Write PHP code that executes complex, multistep scripts. The FileMaker platfrom supports
many script steps in Custom Web Publishing. See “FileMaker scripts and Custom Web
Publishing” on page 17.

1 Write PHP code that performs complex find requests.

Custom Web Publishing requirements
This section explains what is required to develop a Custom Web Publishing solution using PHP,
what web users need in order to access a Custom Web Publishing solution, and what impact
hosting a web publishing solution may have on your server.

What is required to publish a database using Custom Web Publishing
To publish databases using Custom Web Publishing with PHP, you need:

1 a FileMaker Server deployment, which includes three components:
1 a web server, either Microsoft IIS (Windows) or Apache (macOS)—the FileMaker Web
Server Module is installed on the web server

1 the FileMaker Web Publishing Engine
1 the FileMaker Database Server
1 one or more FileMaker Pro databases hosted by FileMaker Server
1 the IP address or domain name of the host running the web server

Chapter 6 | About Custom Web Publishing with PHP

65

1 a web browser and access to the web server to develop and test your Custom Web Publishingsolution

1 PHP installed on the web server—FileMaker Server installs the supported version of PHP, or
you can use your own version

1 For the minimum required version of PHP, see the FileMaker Server technical specifications.
1 For information about PHP, see php.net.
1 The version of PHP installed on the web server must support cURL (client URL library)functions. For information about cURL, see php.net/curl.

Important When you install FileMaker Server, the supported version of PHP does not show
up in the macOS Server Admin tool; it is not supposed to be listed. If you use the macOS Server
Admin tool to turn on PHP, you disable the FileMaker Server supported version of PHP, andenable your own version of PHP.
See FileMaker Server Installation and Configuration Guide.

What web users need to access a Custom Web Publishing solution
To access a Custom Web Publishing solution that uses PHP, web users need:

1 a web browser
1 access to the internet or an intranet and the web server
1 the IP address or domain name of the host running the web server
If the database is password-protected, web users must also enter a user name and password fora database account.

Connecting to the internet or an intranet
When you publish databases on the internet or an intranet, the host computer must be running
FileMaker Server, and the databases you want to share must be hosted and available. In addition:

1 Publish your database on a computer with a full-time internet or intranet connection. You canpublish databases without a full-time connection, but they are only available to web users whenyour computer is connected to the internet or an intranet.

1 The host computer for the web server that is part of the FileMaker Server deployment musthave a dedicated static (permanent) IP address or a domain name. If you connect to the internetwith an internet service provider (ISP), your IP address might be dynamically allocated (it isdifferent each time you connect). A dynamic IP address makes it more difficult for web users tolocate your databases. If you are not sure of the type of access available to you, consult your
ISP or network administrator.

Chapter 6 | About Custom Web Publishing with PHP

66

Manually installing the FileMaker API for PHP
When you install FileMaker Server, the FileMaker supported version of PHP is installed. If you
have a different PHP engine installed and configured and you want to add only the FileMaker API
for PHP, then manually install the FileMaker API for PHP class to make it available to your PHP
scripts. Use the CLI to disable the FileMaker supported version of PHP. See CLI Help.
If you are using your own PHP engine, be sure to do the following configuration tasks on yourversion of the PHP engine:

1 Enable the cURL module in php.ini.
1 Specify the location of the FileMaker API for PHP in the include_path variable in php.ini.
1 If you are accessing databases that contain dates and times, install the pear date package.
Note For the minimum required version of PHP, see the FileMaker Server technicalspecifications. For best results, use the appropriate version of PHP.
To make the FileMaker API for PHP accessible to your PHP scripts
When you installed FileMaker Server, the FileMaker API for PHP package was included as a .zip
file in the following location:

1 For IIS (Windows):[drive]:\Program Files\FileMaker\FileMaker Server\Web
Publishing\FM_API_for_PHP_Standalone.zip
where [drive] is the drive on which the web server component of your FileMaker Server
deployment resides.

1 For Apache (macOS):/Library/FileMaker Server/Web
Publishing/FM_API_for_PHP_Standalone.zip
The FM_API_for_PHP_Standalone.zip file contains a file called FileMaker.php and a folder called
FileMaker. Unzip the file and copy the FileMaker.php file and the FileMaker folder to either of theselocations:

1 the folder where your PHP scripts reside.
1 For IIS (Windows) through HTTP or HTTPS:[drive]:\Program Files\FileMaker\FileMaker Server\HTTPServer\Confwhere [drive] is the drive on which the Web Publishing Engine component of yourFileMaker Server deployment resides.

1 For Apache (macOS) through HTTP:/Library/FileMaker Server/HTTPServer/htdocs

1 For Apache (macOS) through HTTPS:/Library/FileMaker Server/HTTPServer/htdocs/httpsRoot
Note When you import a custom SSL certificate, Database Server client connections use
SSL; HTTP connections are routed to HTTPS. With a custom SSL certificate on your server,
use the HTTPS directory for hosting your PHP site files.

1 one of the include_path directories in your PHP installation. The default location for macOS is/usr/lib/php.

Chapter 6 | About Custom Web Publishing with PHP

67

Where to go from here
1 Use the CLI to enable Custom Web Publishing. See FileMaker Server Help.
1 In FileMaker Pro, open each FileMaker Pro database that you want to publish, and make surethe database has the appropriate extended privileges enabled for Custom Web Publishing. See“Enabling Custom Web Publishing in a database” on page 13.

1 To learn how to access data in FileMaker Pro databases using the FileMaker API for PHP, seechapter 8, “Using the FileMaker API for PHP.”

Chapter 7
Overview of Custom Web Publishing with PHP
The FileMaker API for PHP helps you integrate data from FileMaker Pro databases into PHP
solutions. This chapter describes how PHP works with the FileMaker Server Custom Web
Publishing Engine. For more detailed information about the FileMaker API for PHP, see chapter 8,“Using the FileMaker API for PHP.”

How the Web Publishing Engine works with PHP solutions
FileMaker Server is composed of three components: a web server, the Web Publishing Engine,
and the Database Server. See FileMaker Server Installation and Configuration Guide. To support
PHP solutions, a PHP engine is installed with the web server on the primary machine.
FileMaker Server hosts a PHP solution when you place the PHP files on the primary machine’s
web server.

1 When a web user opens a PHP solution, the web server routes the request to the PHP engine,which processes the PHP code.

1 If the PHP code contains calls to the FileMaker API for PHP, those calls are interpreted and sent
as requests to the Web Publishing Engine.

1 The Web Publishing Engine requests data from databases that are hosted on the Database
Server.

1 The Database Server sends the requested data to the Web Publishing Engine.
1 The Web Publishing Engine sends the data to the PHP engine on the web server in responseto the API call.

1 The PHP solution processes the data, and displays it for the web user.

General steps for Custom Web Publishing with PHP
1. Use FileMaker Pro to enable Custom Web Publishing for a database. See chapter 2, “Preparing
databases for Custom Web Publishing.”
Note Make sure that you use equivalent FileMaker Pro database privilege sets whendeveloping PHP solutions that will be given to the end user. Otherwise, you may have accessto layouts and features in the FileMaker Pro database that will not be available to the end user,
causing inconsistent behavior.
2. Use the FileMaker Server CLI to enable Custom Web Publishing with PHP. See
FileMaker Server Help.
3. In Admin Console, confirm that each FileMaker Pro database you’re publishing has the fmphp
extended privilege enabled.

1 In Admin Console, click the Databases page.
1 Select Show Extended Privileges from the menu selector next to All Databases. The text
FMPHP is displayed for databases that have the fmphp extended privilege enabled.

Chapter 7 | Overview of Custom Web Publishing with PHP

69

4. Use PHP authoring tools to create your PHP solution, incorporating the FileMaker API functions
into your PHP code to access your FileMaker data. See chapter 8, “Using the FileMaker API for
PHP.”
5. Copy or move your site directory structure and files to the following folder on the web server ofthe primary machine.

1 For IIS (Windows) through HTTP or HTTPS:[drive]:\Program Files\FileMaker\FileMaker Server\HTTPServer\Confwhere [drive] is the drive on the primary machine where your FileMaker Server
deployment resides.

1 For Apache (macOS) through HTTP:/Library/FileMaker Server/HTTPServer/htdocs

1 For Apache (macOS) through HTTPS:/Library/FileMaker Server/HTTPServer/htdocs/httpsRoot
Note When you import a custom SSL certificate, Database Server client connections use
SSL; HTTP connections are routed to HTTPS. With a custom SSL certificate, use the HTTPS
directory for hosting PHP site files.
6. If a database container field stores a file reference instead of an actual file, the referenced
container object must be stored in the FileMaker Pro Web folder when the record is created oredited. You must copy or move the object to a folder with the same relative location in the root
folder of the web server software.
See “About publishing the contents of container fields on the web” on page 15.
7. Make sure that security mechanisms for your site or program are in place.
8. Test your site using the same accounts and privileges defined for web users.
9. Make the site available and known to users. The URL that the web user enters follows thisformat:http://<server>/<site_path>

1 <server> is the machine on which the FileMaker Server resides.
1 <site_path> is the relative path to the homepage for your site, determined by the directory
structure you used in 5 above.

ExampleIf your web server is 192.168.123.101 and your site homepage is on the web server at
c:\Inetpub\wwwroot\customers\index.php, then the web user would enter this URL:
http://192.168.123.101/customers/index.php

Note PHP uses Latin-1 (ISO-8859-1) encoding. FileMaker Server returns Unicode (UTF-8) data.
Use the CLI to specify the default character encoding. See CLI Help. For PHP sites, you canspecify either UTF-8 or ISO-8859-1; UTF-8 is recommended. Specify the same setting for thecharset attribute in the <HEAD> section of your site PHP files.
For information on deploying and using a PHP solution, see chapter 9, “Staging, testing, andmonitoring a site.”Chapter 8
Using the FileMaker API for PHP
The FileMaker API for PHP implements a PHP class—the FileMaker class—that provides anobject-oriented interface to FileMaker Pro databases. The FileMaker API for PHP enables bothdata and logic stored in FileMaker Pro databases to be accessed and published on the web, or
exported to other applications.
The FileMaker API for PHP allows PHP code to perform the same kind of functions you alreadyhave available in FileMaker Pro databases:

1 create, delete, edit, and duplicate records
1 perform find requests
1
1
1
1
1

perform field and record validation
use layouts
run FileMaker scripts
display portals and related records
use value lists

This chapter describes how to use the FileMaker class objects and methods to add these common
functions to a PHP solution. This chapter does not cover the entire the FileMaker API for PHP, but
introduces key objects and methods.

Where to get additional information
To learn more about the FileMaker API for PHP, see the following resources.
If you already have a PHP engine installed and configured and you want to add only the FileMaker
API for PHP, see “Manually installing the FileMaker API for PHP” on page 66.

FileMaker API for PHP Reference
If you installed the FileMaker API for PHP, you can find reference information on the web server
component of your FileMaker Server deployment.

1 For IIS (Windows):[drive]:\Program Files\FileMaker\FileMaker Server\Documentation\PHP
API Documentation\index.html
where [drive] is the drive on which the web server component of your FileMaker Server
deployment resides.

1 For Apache (macOS): /Library/FileMaker Server/Documentation/PHP API
Documentation/index.html

FileMaker API for PHP support
You can find additional information about the FileMaker API for PHP on the FileMaker Support
page.

Chapter 8 | Using the FileMaker API for PHP

71

Using the FileMaker class
To use the FileMaker class in your PHP solution, add the following statement to your PHP code:
require_once ('FileMaker.php');

FileMaker class objects
The FileMaker class defines class objects that you can use to retrieve data from FileMaker Pro
databases.
Class object

Use the object toFileMaker Pro database

Define the database properties
Connect to a FileMaker Pro database
Get information about the FileMaker API for PHP

CommandCreate commands that add records, delete records, duplicate records, edit records,
perform find requests, and perform scripts

LayoutWork with database layouts

RecordWork with record data

Field

Work with field data

Related set

Work with portal records

ResultProcess the records returned from a Find request

Error

Check whether an error has occurred
Process any errors

FileMaker command objects
The FileMaker class defines a base command object that you use to instantiate a specificcommand and to specify the command’s parameters. To execute the command, you must call the
execute() method.
The FileMaker class defines the following specific commands:

1 Add command
1 Compound Find command
1
1
1
1
1
1

Delete command
Duplicate command
Edit command
Find command, Find All command, Find Any command
Find Request command, which gets added to a Compound Find command
Perform Script command

Important Commands have different return values, as defined by the FileMaker.php class.
For example, some commands return the Boolean value TRUE or a FileMaker_Error object. Other
commands return a FileMaker_Result object that could contain an entire “found set” of records ina layout. To avoid computer memory overload problems, be aware of the expected return valuesof the commands you use. See the “FileMaker API for PHP Reference” on page 70 for detailed
information about return values for each command.

Chapter 8 | Using the FileMaker API for PHP

72

The basic tasks that most PHP applications need to perform are described in the following:

1 “Working with records” on page 73
1 “Running FileMaker scripts” on page 75
1 “Performing find requests” on page 81

Decoding data for use in the FileMaker API
If your PHP application retrieves data from a website, that data may be URL-encoded. The
FileMaker API for PHP expects data to be decoded strings, not URL-encoded strings. As a generalpractice, you may want to call the urldecode() function when retrieving data in your PHP
application.
Example$user = urldecode($_GET['user']);$event = urldecode($_GET['event']);Note Avoid using strings that include ampersand (&) characters with the FileMaker API for PHP.
Use a backslash as an escape character before special characters in strings passed to theFileMaker API for PHP.

Connecting to a FileMaker Pro database
The FileMaker class defines a database object that you instantiate in order to connect to a server
or to a database. Define the object properties with the class constructor, or by calling the
setProperty() method.
ExamplesConnecting to a server to get a list of databases:$fm = new FileMaker();$databases = $fm->listDatabases();

Connecting to a specific database on a server:$fm = new FileMaker();$fm->setProperty('database', 'questionnaire');$fm->setProperty('hostspec', 'http://192.168.100.110');$fm->setProperty('username', 'web');$fm->setProperty('password', 'web');

The username and password properties determine the privilege set for this connection.
Note The hostspec property defaults to the value http://localhost. Because the PHP
engine is installed with the primary machine’s web server component, there is no need to specify
the hostspec property.

Chapter 8 | Using the FileMaker API for PHP

73

Working with records
The FileMaker class defines a record object that you instantiate to work with records. An instanceof a record object represents one record from a FileMaker Pro database. Use a record object withAdd, Delete, Duplicate, and Edit commands to change the data in the record. The Find
commands—Find, Find All, Find Any, and Compound Find—return an array of record objects.

Creating a record
There are two ways to create a record:

1 Use the createRecord() method, specifying a layout name, and optionally specifying anarray of field values. You can also set values individually in the new record object.

The createRecord() method does not save the new record to the database. To save therecord to the database, call the commit() method.
Example$rec = $fm->createRecord('Form View', $values);$result = $rec->commit();Using the FileMaker_Record commit() method, the $result variable is assigned theBoolean value TRUE and the new record is created in the FileMaker Pro database when there
are no errors.
If an error occurs, the variable $result contains a FileMaker_Error object. Check for errors
after executing the commit() method.

1 Use the Add command. Use the newAddCommand() method to create a

FileMaker_Command_Add object, specifying the layout name and an array with the record
data. To save the record to the database, call the execute() method.
Example$newAdd = $fm->newAddCommand('Respondent', $respondent_data);$result = $newAdd->execute();Using the FileMaker_Command execute() method, the $result variable contains a
FileMaker_Result object with all the information about the created record when there are noerrors.
If an error occurs, the variable $result contains a FileMaker_Error object. Check for errors
after executing the execute() method.

Duplicating a record
Duplicate an existing record using the Duplicate command. Use the newDuplicateCommand()method to create a FileMaker_Command_Duplicate object, specifying the layout name and therecord ID of the record that you want to duplicate. Then, duplicate the record by calling theexecute() method.

Chapter 8 | Using the FileMaker API for PHP

74

Example$newDuplicate = $fm->newDuplicateCommand('Respondent', $rec_ID);$result = $newDuplicate->execute();

Editing a record
There are two ways to edit a record:

1 Using the Edit command. Use the newEditCommand() method to create a

FileMaker_Command_Edit object, specifying the layout name, the record ID of the record you
want to edit, and an array of values that you want to update. Then, edit the record by calling theexecute() method.
Example$newEdit = $fm->newEditCommand('Respondent', $rec_ID, $respondent_data);$result = $newEdit->execute();1 Using a record object. Retrieve a record from the database, change field values, and then edit
the record by calling the commit() method.
Example$rec = $fm->getRecordById('Form View', $rec_ID);$rec->setField('Name', $nameEntered);$result = $rec->commit();

Deleting a record
There are two ways to delete a record:

1 Retrieve a record from the database, and then call the delete() method.
Example$rec = $fm->getRecordById('Form View', $rec_ID);$rec->delete();1 Delete an existing record using the Delete command. Use the newDeleteCommand() method
to create a FileMaker_Command_Delete object, specifying the layout name and the record IDof the record you want to delete. Then, delete the record by calling the execute() method.
Example$newDelete = $fm->newDeleteCommand('Respondent', $rec_ID);$result = $newDelete->execute();Chapter 8 | Using the FileMaker API for PHP

75

Running FileMaker scripts
A FileMaker script is a named set of script steps. The FileMaker class defines several methods
that allow you to work with FileMaker scripts defined in a FileMaker Pro database. For information
on web-compatible script steps (the script steps that can be performed in a web solution), see“FileMaker scripts and Custom Web Publishing” on page 17.

Obtaining the list of available scripts
Use the listScripts() method to get a list of available scripts from the currently connected
database. The listScripts() method returns an array of scripts that can be executed by theusername and password specified when the database connection was defined. (See “Connecting
to a FileMaker Pro database” on page 72.)
Example$scripts = $fm->listScripts();

Running a FileMaker script
Use the newPerformScriptCommand() method to create a
FileMaker_Command_PerformScript object, specifying the layout, script name, and any script
parameters. Then, perform the script by calling the execute() method.
Important When running a FileMaker script, the size of the FileMaker_Result object that isreturned depends on behavior of the FileMaker script. For example, if a FileMaker script switches
to a specified layout, then all of the records from that layout’s table may be in the found set, andall of the records in that found set could be returned in the FileMaker_Result object. To avoid
computer memory overload problems, be aware of the data returned by a FileMaker script before
running that FileMaker script in a PHP application.
Example$newPerformScript = $fm->newPerformScriptCommand('Order Summary','ComputeTotal');$result = $newPerformScript->execute();Running a script before executing a command
Use the setPreCommandScript() method to specify a script that runs before a command isrun. The following example uses a Find command, but you can use the
setPreCommandScript() method with any command.
Example$findCommand = $fm->newFindCommand('Students');$findCommand->addFindCriterion('GPA', $searchValue);$findCommand->setPreCommandScript('UpdateGPA');$result = $findCommand->execute();Chapter 8 | Using the FileMaker API for PHP

76

Running a script before sorting a result set
Use the setPreSortScript() method to specify a script that is run after a Find result set isgenerated, but before the result set is sorted. See “Using the Find command” on page 82.
Example$findCommand = $fm->newFindCommand('Students');$findCommand->setPreSortScript('RemoveExpelled');Running a script after the result set is generated
Use the setScript() method to specify a script that is run after a Find result set is generated.
See “Using the Find command” on page 82.
Example$findCommand = $fm->newFindCommand('Students');$findCommand->setScript('myScript','param1|param2|param3');

Script execution order
You can specify the setPreCommandScript(), setPreSortScript(), and setScript()
methods in conjunction with the setResultLayout() and addSortRule() methods for asingle command.
Here is the order in which FileMaker Server and the Web Publishing Engine process thesemethods:
1. Run the script specified on the setPreCommandScript() method, if specified.
2. Process the command itself, such as a Find or Delete Record command.
3. Run the script specified on the setPreSortScript() method, if specified.
4. Sort the Find result set, if the addSortRule() method was specified.
5. Process the setResultLayout() method to switch to a different layout, if this is specified.
6. Run the script specified on the setScript() method, if specified.
7. Return the final Find result set.
If one of the above steps generates an error code, the command execution stops; any steps that
follow are not executed. However, any prior steps in the request are still executed.
For example, consider a command that deletes the current record, sorts the records, and thenexecutes a script. If the addSortRule() method specifies a nonexistent field, the request
deletes the current record and returns error code 102 (“Field is missing”), but does not executethe script.
The layout specified for the newFindCommand() method is used when processing the findrequest. When the setResultLayout() method switches to another layout, the error object for
the find request based on the original layout is no longer available. To test the error object fromthe find request based on the original layout, check the error object before changing the layout.

Chapter 8 | Using the FileMaker API for PHP

77

Examplerequest = $fm->newFindCommand('Students');$request->addFindCriterion('Day', 'Wednesday');// Perform the Find
$result = $request->execute();if (FileMaker::isError($result)) {if ($result->code = 401) {$findError = 'There are no Records that match that request: '. ' (' .
$result->code . ')';
} else {$findError = 'Find Error: '. $result->getMessage(). ' (' . $result->code. ')';}}$request->setResultLayout(’Teachers’);// Switch to the result layout$result = $request->execute();Working with FileMaker Pro layouts
A layout is the arrangement of fields, objects, pictures, and layout parts that represents the way
information is organized and presented when the user browses, previews, or prints records. The
FileMaker class defines several methods that allow you to work with the layouts defined in a
FileMaker Pro database. You can get information about layouts from several of the FileMaker
class objects.
With this class object

Use these methods

Database

1 listLayouts() obtains a list of available layout names.
1 getLayout() obtains a layout object by specifying a layout name.

Layout1 getName() retrieves the layout name of a specific layout object.
1 listFields() retrieves an array of all field names used in a layout.
1 getFields() retrieves an associative array with the names of all fields as keys, andthe associated FileMaker_Field objects as array values.

1 listValueLists() retrieves an array of value list names.
1 listRelatedSets() retrieves an array of related sets names.
1 getDatabase() returns the name of the database.
Record1 getLayout() returns the layout object associated with a specific record.

Field

1 getLayout() returns the layout object containing specific field.

Command

1 setResultLayout() returns the command’s results in a layout different from thecurrent layout.

Chapter 8 | Using the FileMaker API for PHP

78

Using portals
A portal is table that displays rows of data from one or more related records. The FileMaker classdefines a related set object and several methods that allow you to work with portals defined in a
FileMaker Pro database.
A related set object is an array of record objects from the related portal; each record object
represents one row of data in the portal.

Listing the portals defined on a specific layout
For a specific layout object, use the listRelatedSets() method to retrieve a list of tablenames for all portals defined in this layout.
Example$tableNames = $currentLayout->listRelatedSets();

Obtaining portal names for a specific result object
For a specific FileMaker_Result object, use the getRelatedSets() method to retrieve thenames of all portals in this record.
Example$relatedSetsNames = $result->getRelatedSets();

Obtaining information about portals for a specific layout
For a specific layout object, use the getRelatedSets() method to retrieve an array of
FileMaker_RelatedSet objects that describe the portals in the layout. The returned array is anassociative array with the table names as the array keys, and the associatedFileMaker_RelatedSet objects as the array values.
Example$relatedSetsArray = $currentLayout->getRelatedSets();

Obtaining information for a specific portal
For a specific layout object, use the getRelatedSet() method to retrieve theFileMaker_RelatedSet object that describes a specific portal.
Example$relatedSet = $currentLayout->getRelatedSet('customers');

Chapter 8 | Using the FileMaker API for PHP

79

Obtaining the table name for a portal
For a related set object, use the getName() method to get the table name for the portal.
Example$tableName = $relatedSet->getName();Obtaining the portal records for a specific record
For a specific record object, use the getRelatedSet() method to retrieve an array of related
records for a specific portal on that record.
Example$relatedRecordsArray = $currentRecord->getRelatedSet('customers');

Creating a new record in a portal
Use the newRelatedRecord() method to create a new record in the specified related set, andcommit the change to the database by calling the commit() method.
Example//create a new portal row in the 'customer' portal$new_row = $currentRecord->newRelatedRecord('customer');//set the field values in the new portal row$new_row->setField('customer::name', $newName);$new_row->setField('customer::company', $newCompany);$result = $new_row->commit();

Deleting a record from a portal
Use the delete() method to delete a record in a portal.
Example$relatedSet = $currentRecord->getRelatedSet('customers');/* Runs through each of the portal rows */foreach ($relatedSet as $nextRow) {$nameField = $nextRow->getField('customer::name')if ($nameField == $badName ) {$result = $newRow->delete();}}Chapter 8 | Using the FileMaker API for PHP

80

Using value lists
A value list is set of predefined choices. The FileMaker class defines several methods that allow
you to work with value lists defined in a FileMaker Pro database.

Obtaining the names of all value lists for a specific layout
For a specific layout object, use the listValueLists() method to retrieve an array that
contains value list names.
Example$valueListNames = $currentLayout->listValueLists();

Obtaining an array of all value lists for a specific layout
For a specific layout object, use the getValueListsTwoFields() method to retrieve an array
containing the values from all value lists. The returned array is an associative array. The array keys
are the value list names, and the array values are associative arrays that list the display names
and their corresponding choices from each value list.
Example$valueListsArray = $currentLayout->getValueListsTwoFields();

Note Although the getValueLists() method is still supported in the FileMaker API for PHP,
it will be deprecated. Instead, use the getValueListsTwoFields() method.

Obtaining the values for a named value list
For a specific layout object, use the getValueListTwoFields() method to get an array ofchoices defined for the named value list. The returned array is an associative array that contains
the displayed values from the second field of the value list as the keys, and the associated stored
values from the first field as the array values.
Depending on the options selected in the Specify Fields for Value List dialog box in the FileMaker
Pro database, the getValueListTwoFields() method returns the value in the first field only,
the value in the second field only, or the values in both fields of a value list as the stored anddisplayed values.

1 If Also display values from second field is not selected, the getValueListTwoFields()
method returns the value from the first field of the value list as both the stored value and thedisplayed value.

1 If Also display values from second field and Show values only from second field are both
selected, the getValueListTwoFields() method returns the value from the first field as
the stored value, and the value from the second field as the displayed value.

1 If Also display values from second field is selected and Show values only from second

field is not selected, the getValueListTwoFields() method returns the value from the first
field as the stored value, and both values from the first and second fields as the displayed value.

Chapter 8 | Using the FileMaker API for PHP

81

Use an iterator with the getValueListTwoFields() method to find the displayed value andstored value.
Example$layout = $fm->getLayout('customers');$valuearray = $layout->getValueListTwoFields("region", 4);foreach ($valuearray as $displayValue => $value) {
....
}

Notes

1 Although the getValueList() method is still supported in the FileMaker API for PHP, it will
be deprecated. Instead, use the getValueListTwoFields() method.

1 When using the getValueListTwoFields() method, be sure to use a foreach loop toloop through the associative array. Do not use a for loop because it can return unexpected
results.

Performing find requests
The FileMaker class defines four kinds of Find command objects:

1
1
1
1

Find All command. See “Using the Find All command” on page 82.
Find Any command. See “Using the Find Any command” on page 82.
Find command. See “Using the Find command” on page 82.
Compound Find command. See “Using a Compound Find command” on page 83.

The FileMaker class also defines several methods that can be used for all four types of Find
commands:

1 Use the addSortRule() method to add a rule defining how the result set is sorted. Use theclearSortRules() method to clear all sort rules that have been defined.

1 Use the setLogicalOperator() method to change between logical AND searches andlogical OR searches.

1 Use the setRange() method to request only part of the result set. Use the getRange()method to retrieve the current range definition.

Using the setRange() method can improve the performance of your solution by reducing thenumber records that are returned by the Find request. For example, if a Find request returns
100 records, you can split the result set into five groups of 20 records each rather thanprocessing all 100 records at once.

1 You can execute FileMaker scripts in conjunction with Find commands.
1 To run a script before executing the Find command, use the setPreCommandScript()
method.

1 To run a script before sorting the result set, use the setPreSortScript() method.
1 To run a script after a result set is generated, but before the result set is sorted, use the
setScript() method.

Chapter 8 | Using the FileMaker API for PHP

82

Using the Find All command
Use the Find All command to retrieve all records from a specified layout. Use the
newFindAllCommand() method, specifying a specific layout, to create a
FileMaker_Command_FindAll object. Then, perform the find request by calling the execute()
method.
Example$findCommand = $fm->newFindAllCommand('Form View');$result = $findCommand->execute;

Note When using the Find All command, avoid computer memory overload problems by
specifying a default maximum number of records to return per page.

Using the Find Any command
Use the Find Any command to retrieve one random record from a specified layout. Use the
newFindAnyCommand() method, specifying a specific layout, to create a
FileMaker_Command_FindAny object. Then, perform the find request by calling the execute()
method.
Example$findCommand = $fm->newFindAnyCommand('Form View');$result = $findCommand->execute;

Using the Find command
Use the newFindCommand() method, specifying a specific layout, to create a
FileMaker_Command_Find object. Then, perform the find request by calling the execute()
method.
Note Make sure the layout name is unique. If your database has two layouts with the same
name, the FileMaker API for PHP cannot distinguish between them. In addition, the API is not casesensitive. For example, if your database has one layout named Websites and another layout
named WebSites, the API cannot distinguish between them.

Chapter 8 | Using the FileMaker API for PHP

Use the addFindCriterion() method to add criteria to the find request. Use theclearFindCriteria() method to clear all find criteria that have been defined.
ExamplesFinding a record by field name:$findCommand = $fm->newFindCommand('Form View');$findCommand->addFindCriterion('Questionnaire ID',
$active_questionnaire_id);$result = $findCommand->execute();Adding a sort order:$findCommand = $fm->newFindCommand('Customer List');$findCommand->addSortRule('Title', 1, FILEMAKER_SORT_ASCEND);$result = $findCommand->execute();Using a Compound Find command
The Compound Find command lets you combine multiple Find Request objects into one
command. There are several ways to create a Compound Find command:

1 Create a FileMaker_Command_CompoundFind object by calling the
newCompoundFindCommand() method.

1 Create one or more FileMaker_Command_FindRequest objects by calling the
newFindRequest() method.

1 Use the add() method to add the Find Request objects to the Compound Find command
object.

1 Perform the Compound Find command by calling the execute() method.

83

Chapter 8 | Using the FileMaker API for PHP

ExampleCompound Find command:// Create the Compound Find command object$compoundFind = $fm->newCompoundFindCommand('Form View');// Create first find request$findreq1 = $fm->newFindRequest('Form View');// Create second find request$findreq2 = $fm->newFindRequest('Form View');// Create third find request$findreq3 = $fm->newFindRequest('Form View');// Specify search criterion for first find request$findreq1->addFindCriterion('Quantity in Stock', '<100');// Specify search criterion for second find request$findreq2->addFindCriterion('Quantity in Stock', '0');// Specify search criterion for third find request$findreq3->addFindCriterion('Cover Photo Credit', 'The London Morning
News');// Add find requests to compound find command$compoundFind->add(1,$findreq1);$compoundFind->add(2,$findreq2);$compoundFind->add(3,$findreq3);// Set sort order$compoundFind->addSortRule('Title', 1, FILEMAKER_SORT_DESCEND);// Execute compound find command$result = $compoundFind->execute();// Get records from found set$records = $result->getRecords();// Print number of records foundecho 'Found '. count($records) . " results.<br><br>";84

Chapter 8 | Using the FileMaker API for PHP

85

Processing the records in a result set
1 Retrieve an array containing each record in the result set by calling the getRecords()

method. Each member of the array is a FileMaker_Record object, or an instance of the classname set in the API for instantiating records. The array may be empty if the result set contains
no records.

1 Get a list of field names for all fields in the result set by calling the getFields() method. The

method returns only the field names. If you need additional information about the fields, use theassociated layout object.

1 Get the number of records in the entire found set by calling the getFoundSetCount()
method.

1 Get the number of records in the filtered found set by calling the getFetchCount() method.
If no range parameters were specified on the Find command, then this value is equal to theresult of the getFoundSetCount() method. It is always equal to the value ofcount($response->getRecords()).

1 For a specific record, use the getField() method to return the contents of a field as a string.
1 For a specific record, use the getFieldAsTimestamp() method to return the contents of afield as a Unix timestamp (the PHP internal representation of a date).

1 If the field is a date field, the timestamp is for the field date at midnight.
1 If the field is a time field, the timestamp is for that time on January 1, 1970.
1 If the field is a timestamp field, the FileMaker timestamp value maps directly to the Unix
timestamp.

1 If the specified field is not a date or time field, or if the timestamp generated would be out ofrange, the getFieldAsTimestamp() method return a FileMaker_Error object.

1 For a specific record, use the getContainerData() method to return a container field object
as binary data:<IMG src=”img.php?-url=<?php echo urlencode($record->getField('CoverImage')); ?>”>
echo $fm->getContainerData($_GET['-url']);1 For a specific record, use the getContainerDataURL() method to return a fully qualified
URL for the container field object:// For images, use the HTML img tag
echo '<img src="'.$fm->
getContainerDataURL($record->getField('container')) .'">';// For movies and PDF files, use the HTML embed tag//echo '<embed src="'.$fm->
getContainerDataURL($record->getField('container')) .'">';

Chapter 8 | Using the FileMaker API for PHP

86

Limiting the portal rows returned by find requests
In a solution that has many related records, querying and sorting portal records can be time
consuming. To limit the number of records to display in a related set, use thesetRelatedSetsFilters() method with find requests. The setRelatedSetsFilters()
method takes two arguments:

1 a related sets filter value: layout or none
1 If you specify the value none, the Web Publishing Engine returns all rows in the portal, andportal records are not presorted.

1 If you specify the value layout, then the settings specified in the FileMaker Pro Portal Setup
dialog box are respected. The records are sorted based on the sort defined in the Portal
Setup dialog box, with the record set filtered to start with the initial row specified.

1 the minimum number of portal records returned: an integer value or all
1 This value is used only if the Allow vertical scrolling setting is enabled in the Portal Setup
dialog box. If you specify an integer value, that number of rows after the initial row are
returned. If you specify all, the Web Publishing Engine returns all of the related records.

1 If the Allow vertical scrolling setting is disabled, the Portal Setup dialog box’s Number ofrows setting determines the maximum number of related records that are returned.

Note The Filter portal records setting in the Portal Setup dialog box is not supported for PHP
queries. Any calculation specified for the Filter portal records setting is ignored.

Prevalidating commands, records, and fields
The FileMaker class lets you prevalidate field data in a PHP solution on the web server before
committing the data to the database.
Prevalidation is disabled by default. Use the CLI to enable prevalidation. See CLI Help.
When deciding whether to use prevalidation, consider the number of data values that the web user
is entering. If the user is updating a small number of fields, then you could improve performanceby not using prevalidation. But if the user is entering data for many fields, then prevalidation cankeep the user from being frustrated by having a record rejected by the database for validation
errors.
With the FileMaker class, the PHP engine prevalidates the following field constraints:

1 not empty
Valid data is a non-empty character string. The data must contain at least one character.

1 numeric only
Valid data contains numeric characters only.

1 maximum number of characters
Valid data contains at most the maximum number of characters specified.

Chapter 8 | Using the FileMaker API for PHP

87

1 four-digit year
Valid data is a character string representing a date with a four-digit year in the format
M/D/YYYY, where M is a number between 1 and 12 inclusive, D is a number between 1 and 31
inclusive, and YYYY is a four-digit number between 0001 and 4000 inclusive. For example,
1/30/3030 is a valid four-digit year value. However, 4/31/2019 is an invalid four-digit year
value because April does not have 31 days. Date validation supports forward slash (/), backslash (\), and hyphen (-) as delimiters. However, the string cannot contain a mix of delimiters.
For example, 1\30-2019 is invalid.

1 time of day
Valid data is a character string representing a 12-hour time value in the one of these formats:

1 h
1 h:m
1 h:m:s
1 h:m:s AM/PM
1 h:m AM/PM
where h is a number between 1 and 12 inclusive; m and s are numbers between 1 and 60
inclusive.
The PHP engine prevalidation supports implicit checking of field data based on the type of the
field:

1 dateA field defined as a date field is validated according to the rules of “four-digit year” validation,
except the year value can contain 0-4 digits (the year value can be empty). For example, 1/30
is a valid date even though it has no year specified.

1 timeA field defined as a time field is validated according to the rules of “time of day” validation,
except the hour component (H) can be a number between 1 and 24 inclusive to support 24-hourtime values.

1 timestamp
A field defined as a timestamp field is validated according to the rules of “time” validation for thetime component and according to the rules of “date” validation for the date component.
The FileMaker class cannot prevalidate all of the field validation options that are available in
FileMaker Pro. The following validation options cannot be prevalidated because they are
dependent on the state of all the data in the database at the time that the data is committed:

1
1
1
1
1

unique value
existing value
in rangemember of value list
validate by calculation

Chapter 8 | Using the FileMaker API for PHP

88

Prevalidating records in a command
For a command object, use the validate() method to validate one field or the entire commandagainst the prevalidation rules enforceable by the PHP engine. If you pass the optional field nameargument, only that field is prevalidated.
If the prevalidation passes, then the validate() method returns TRUE. If the prevalidation fails,
then the validate() method returns a FileMaker_Error_Validation object containing details
about what failed to validate.

Prevalidating records
For a record object, use the validate() method to validate one field or all the fields in the record
against the prevalidation rules enforceable by the PHP engine. If you pass the optional field nameargument, only that field is prevalidated.
If the prevalidation passes, then the validate() method returns TRUE. If the prevalidation fails,
then the validate() method returns a FileMaker_Error_Validation object containing details
about what failed to validate.

Prevalidating fields
For a field object, use the validate() method to determine whether a given value is valid for afield.
If the prevalidation passes, then the validate() method returns TRUE. If the prevalidation fails,
then the validate() method returns a FileMaker_Error_Validation object containing details
about what failed to validate.

Processing the validation errors
When prevalidation fails, the FileMaker_Error_Validation object returned contains a three-element
array for each validation failure:
1. The field object that failed prevalidation
2. A validation constant value that indicates the validation rule that failed:
1 - FILEMAKER_RULE_NOTEMPTY
2 - FILEMAKER_RULE_NUMERICONLY
3 - FILEMAKER_RULE_MAXCHARACTERS
4 - FILEMAKER_RULE_FOURDIGITYEAR
5 - FILEMAKER_RULE_TIMEOFDAY
6 - FILEMAKER_RULE_TIMESTAMP_FIELD
7 - FILEMAKER_RULE_DATE_FIELD
8 - FILEMAKER_RULE_TIME_FIELD
3. The actual value entered for the field that failed prevalidation

Chapter 8 | Using the FileMaker API for PHP

89

You can also use the following methods with a FileMaker_Error_Validation object:

1 Use the isValidationError() method to test whether the error is a validation error.
1 Use the numErrors() method to get the number of validation rules that failed.
Example//Create an Add request$addrequest = $fm->newAddCommand('test', array('join' => 'added', 'maxchars'=> 'abcx', 'field' => 'something' , 'numericonly' => 'abc'));//Validate all fields$result = $addrequest->validate();//If the validate() method returned any errors, print the name of the field,
the error number, and the value that failed.
if(FileMaker::isError($result)){echo 'Validation failed:'. "\n";$validationErrors= $result->getErrors();
foreach ($validationErrors as $error) {$field =$error[0];echo 'Field Name: ' .

$field->getName(). "\n";echo 'Error Code: ' .

$error[1] . "\n";echo 'Value: ' .

$error[2] . "\n";}}ResultValidation failed:
Field Name: numericonly
Error Code: 2
Value: abc
Field Name: maxchars
Error Code: 3
Value: abcx

Chapter 8 | Using the FileMaker API for PHP

90

Handling errors
The FileMaker class defines the FileMaker_Error object to help you handle errors that occur in a
PHP solution.
An error can occur when a command runs. If an error does occur, the command returns a
FileMaker_Error object. It is a good practice to check the error that is returned when a commandruns.
Use the following methods to learn more about the error indicated in the FileMaker_Error object.

1 Test for whether a variable is a FileMaker Error object by calling the isError() method.
1 Get the number of errors that occurred by calling the numErrors() method.
1 Retrieve an array of arrays describing the errors that occurred by calling the getErrors()
method.

1 Display an error message by calling the getMessage() method.
Example$result = $findCommand->execute();if (FileMaker::isError($result)) {echo "<p>Error: " . $result->getMessage() . "</p>";exit;}

For information about the error codes returned with the FileMaker Error object, see appendix A,“Error codes for Custom Web Publishing.”

Chapter 9
Staging, testing, and monitoring a site
This chapter provides instructions for staging and testing a Custom Web Publishing site before
deploying it in a production environment. Instructions are also provided for using log files tomonitor the site during testing or after deployment.

Staging a Custom Web Publishing site
Before you can properly test your site, you must copy or move the required files to the correct
locations on the staging server(s).
1. Complete all of the steps outlined in chapter 2, “Preparing databases for Custom Web
Publishing.”
2. Check that Custom Web Publishing has been enabled and properly configured using the CLI.
See FileMaker Server Help.
3. Verify that the web server and the Web Publishing Engine are running.
4. Copy or move your site files to the web server component of your FileMaker Server
deployment.
Copy or move your site files to the following directory:

1 IIS (Windows) through HTTP or HTTPS:[drive]:\Program Files\FileMaker\FileMaker Server\HTTPServer\Confwhere [drive] is the drive of your FileMaker Server primary machine.

1 Apache (macOS) through HTTP:/Library/FileMaker Server/HTTPServer/htdocs

1 Apache (macOS) through HTTPS:/Library/FileMaker Server/HTTPServer/htdocs/httpsRoot
Note When you import a custom SSL certificate, Database Server client connections use
SSL; HTTP connections are routed to HTTPS. With a custom SSL certificate, use the HTTPS
directory for hosting PHP site files.

Chapter 9 | Staging, testing, and monitoring a site92

5. If you have not already done so, copy or move any referenced container field objects to theappropriate directory on the primary machine.

1 If the database file is properly hosted and accessible on the Database Server component of
the FileMaker Server deployment, and the container fields store the actual files in the
FileMaker Pro database, then you don’t need to relocate the container field contents.

1 If a database container field stores a file reference instead of an actual file, then thereferenced container object must be stored in the FileMaker Pro Web folder when the record
is created or edited. To stage your site, you must copy or move the referenced containers toa folder with the same relative location in the root folder of the web server software.

1 When you use FileMaker Pro to upload a database with container fields that store objects

externally, the externally stored container field data is uploaded to FileMaker Server as partof the process. See FileMaker Pro Help for information on transferring the database files to
FileMaker Server.

1 When you manually upload a database that uses a container field with externally stored
objects, then you must copy or move the referenced objects into a subfolder of the
RC_Data_FMS folder, as described in “Container fields with externally stored data” onpage 16.

6. Copy any additional components of your web application to the primary machine. For Custom
Web Publishing with XML, your web application processes the XML data before sending it toanother application or to the client.

Testing a Custom Web Publishing site
Before notifying users that your Custom Web Publishing site is available, verify that it looks andfunctions as you expect.

1 Test features like finding, adding, deleting, and sorting records with different accounts andprivilege sets.

1 Verify that privilege sets are performing as expected by signing in with different accounts. Make
sure unauthorized users can’t access or modify your data.

1 Check all scripts to verify that the outcome is expected. See “FileMaker scripts and Custom
Web Publishing” on page 17 for information on designing web-friendly scripts.

1 Test your site with different operating systems and web browsers.
1 When creating solutions that use the FileMaker API for PHP, it is recommended that you build

your solutions with cookie support enabled. The FileMaker API for PHP has better response
times with cookies enabled. Cookies are not required to use Custom Web Publishing features,
but cookies do allow the Web Publishing Engine to cache session information.
Note You can view and test your site on the primary machine without using a network
connection by using http://127.0.0.1/ in the URL.

1 For PHP solutions, use http://127.0.0.1/<site_path>where <site_path> is the relative path to the homepage for your site.

1 For information on the URL syntax in XML solutions, see “About the URL syntax for XML dataand container objects” on page 25.

Chapter 9 | Staging, testing, and monitoring a site

Stylesheets for testing XML output
ExamplesHere are two examples of XSLT stylesheets that are useful for testing XML output.
The following stylesheet example outputs the requested XML data without doing any
transformation. This stylesheet is useful for displaying the actual XML data that the Web
Publishing Engine is using.
<?xml version="1.0" encoding="UTF-8"?><xsl:stylesheet version="1.0"
xmlns:xsl="http://www.w3.org/1999/XSL/Transform"
xmlns:fmrs="http://www.filemaker.com/xml/fmresultset"><xsl:output method="xml"/><xsl:template match="/"><xsl:copy-of select="."/></xsl:template></xsl:stylesheet>

When debugging a stylesheet, you can use the following example of an HTML <textarea> tag
to display the XML source document that was accessed via the stylesheet in a scrolling text
area.
<?xml version="1.0" encoding="UTF-8"?><xsl:stylesheet version="1.0"
xmlns:xsl="http://www.w3.org/1999/XSL/Transform"
xmlns:fmrs="http://www.filemaker.com/xml/fmresultset"><xsl:output method="html"/><html><body><xsl:template match="/fmrs:fmresultset"><textarea rows="20" cols="100"><xsl:copy-of select="."/></textarea><br/></xsl:template></body></html></xsl:stylesheet>

93Chapter 9 | Staging, testing, and monitoring a site

94

Monitoring your site
You can use the following types of log files to monitor your Custom Web Publishing site and gather
information about web users who visit your site:

1
1
1
1

Web server access and error logs
Web Publishing Engine log
Web Server Module error log
Tomcat logs

Using the web server access and error logs
IIS (Windows): The Microsoft IIS web server generates an access log file and displays errors in
the Windows Event Viewer instead of writing them to a log file. The access log file, which is in the
W3C Extended Log File Format by default, is a record of all incoming HTTP requests to the web
server. You can also use the W3C Common Logfile Format for the access log. See thedocumentation for the Microsoft IIS web server.
Apache (macOS): The Apache web server generates an access log file and an error log file. The
Apache access log file, which is in the W3C Common Logfile Format by default, is a record of all
incoming HTTP requests to the web server. The Apache error log is a record of problems involving
processing HTTP requests. See the documentation for the Apache web server.
Note For information on the W3C Common Logfile Format and the W3C Extended Log File
Format, see the World Wide Web Consortium website at www.w3.org.

Using the Web Publishing Engine log
The Web Publishing Engine generates a log file called wpe.log that contains a record of any Web
Publishing Engine errors that have occurred, including application errors, usage errors, andsystem errors.
The wpe.log file is generated if the Web Publishing Engine is running. (See Admin Console toverify if the Web Publishing Engine is running.)
The wpe.log file is located on the Web Publishing Engine component of the FileMaker Server
deployment:

1 Windows:[drive]:\Program Files\FileMaker\FileMaker Server\Logs\wpe.log
where [drive] is the primary drive from which the system is started.

1 macOS: /Library/FileMaker Server/Logs/wpe.log
Web Publishing Engine log format
The wpe.log file uses the following format for each entry:[TIMESTAMP_GMT] [WPC_HOSTNAME] [CLIENT_IP:PORT] [ACCOUNT_NAME] [MODULE_TYPE][SEVERITY] [FM_ERRORCODE] [RETURN_BYTES] [MESSAGE]

where:

1 [TIMESTAMP_GMT] is the date and time of the entry, in Greenwich Mean Time (GMT).
1 [WPC_HOSTNAME] is the machine name for the primary machine.
1 [CLIENT_IP:PORT] is the IP address and port of the client where the XML request originated.

Chapter 9 | Staging, testing, and monitoring a site95

1 [ACCOUNT_NAME] is the account name used for signing in to the hosted FileMaker Pro
database.

1 [MODULE_TYPE] is either: XML, for Custom Web Publishing with XML requests, or PHP, forCustom Web Publishing with PHP requests.

1 [SEVERITY] is either INFO, indicating an informational message, or ERROR, indicating anerror message.

1 [FM_ERROR_CODE] is the error number returned for an error message. The error number may
be an error code for FileMaker Pro databases (see “Error code numbers for FileMaker Pro
databases” on page 98).

In addition, the error number may be an HTTP error number, prefixed by an “HTTP:” string.

1 [RETURN_BYTES] is the number of bytes returned by the request.
1 [MESSAGE] provides additional information about the log entry.
Web Publishing Engine log message
ExamplesThe following examples show the types of messages that may be included in the wpe.log file.
When the Web Publishing Engine starts and stops:
2019-06-02 15:15:31 -0700
Web Publishing Engine started.

-

-

INFO

-

-

FileMaker Server

2019-06-02 15:46:52 -0700
Web Publishing Engine stopped.

-

-

INFO

-

-

FileMaker Server

Successful or failed XML query requests:
2019-06-02 15:21:08 -0700 WPC_SERVER 192.168.100.101:0 jdoe XML INFO
03964"/fmi/xml/fmresultset.xml?-db=Contacts&-lay=Contact_Details&findall"
2019-06-02 15:26:31 -0700
WPC_SERVER
192.168.100.101:0
ERROR
5
596
"/fmi/xml/fmresultset.xml?-db=Contacts&layout=Contact_Details&-findall"

jdoe

XML

Scripting errors:
2019-06-02 17:33:12 -0700 WPC_SERVER 192.168.100.101:0 jdoe - ERROR
4 - Web Scripting Error: 4, File: "10b_MeetingsUpload", Script: "OnOpen",
Script Step: "Show Custom Dialog"

Changes to the Custom Web Publishing settings:
2019-06-09 10:59:49 -0700 WPC_SERVER 192.168.100.101:0
XML Web Publishing Engine is enabled.

jdoe

-

INFO

System errors:
2019-06-02 15:30:42 -0700
WPC_SERVER
ERROR- Communication failed

192.168.100.101:0

jdoe

XML

Chapter 9 | Staging, testing, and monitoring a site

96

Using the Web Server Module error log
If the web server is unable to connect to the Web Publishing Engine, the Web Server Module
generates a log file that records any errors with its operation. This file is called
web_server_module_log.txt and is located in the Logs folder in the FileMaker Server folder on the
web server host.

Using the Tomcat logs
When FileMaker Server has a problem caused by an internal web server error, you may find it
helpful to view the Tomcat logs. The Tomcat logs are located on the web server component of theFileMaker Server deployment:

1 Windows: [drive]:\Program Files\FileMaker\FileMaker Server\Web
Publishing\publishing-engine\jwpc-tomcat\logs
where [drive] is the primary drive from which the system is started.

1 macOS: /Library/FileMaker Server/Web Publishing/publishingengine/jwpc-tomcat/logs

Appendix A
Error codes for Custom Web Publishing
The Web Publishing Engine generates error codes for database and query string errors that may
occur during an XML data request.
For a list of updated error codes, see the Knowledge Base.

Error code numbers in XML format
The Web Publishing Engine generates an error code for databases published in XML format
whenever data is requested. This type of error code value is inserted at the beginning of the XML
document in the <error code> element for the fmresultset grammar, or in the<ERRORCODE> element for the FMPXMLRESULT or FMPXMLLAYOUT grammars. An error code of 0
indicates that no error has occurred.
ExamplesDatabase error code in the fmresultset grammar:<?xml version="1.0" encoding="UTF-8" standalone="no"?><!DOCTYPE fmresultset PUBLIC "-//FMI//DTD fmresultset//EN""http://192.168.123.101/fmi/xml/fmresultset.dtd"><fmresultset xmlns="http://www.filemaker.com/xml/fmresultset"
version="1.0"><error code="0"></error>

Database error code in the FMPXMLRESULT grammar:<?xml version="1.0" encoding="UTF-8" standalone="no"?><!DOCTYPE FMPXMLRESULT PUBLIC "-//FMI//DTD FMPXMLRESULT//EN""http://192.168.123.101/fmi/xml/FMPXMLRESULT.dtd"><fmpxmlresult xmlns="http://www.filemaker.com/fmpxmlresult"><ERRORCODE>0</ERRORCODE>

It is up to you, as the developer of the Custom Web Publishing solution, to check the value of the<error code> or <ERRORCODE> element and handle it appropriately. The Web Publishing
Engine does not handle database errors.

Appendix A | Error codes for Custom Web Publishing98

Error code numbers for FileMaker Pro databases
For FileMaker Pro error codes, see FileMaker Pro Help.
FileMaker Server provides error code 959 to indicate that a technology has been disabled.
For example, if the server administrator disables Custom Web Publishing using the CLI, then XML
queries return the error code 959.
ExampleError code 959 in the FMPXMLLAYOUT grammar:<FMPXMLLAYOUT><ERRORCODE>959</ERRORCODE><LAYOUT DATABASE="" NAME=""/><VALUELISTS/></FMPXMLLAYOUT>IndexA
access log files for web server, described 94
access privileges 14
accounts and privileges
enabling for Custom Web Publishing 13
Guest account 14
scripts 18
Add command 73
add() method 83
addSortRule() method 81
Admin Console 14
Allow vertical scrolling setting 58, 86
ampersand characters, in PHP 72
application log 94
ASCII characters, in XML documents 38
authentication of web users 13
auto-enter attribute 31
available scripts 51

B
Basic Authentication for web users 13

C
Change Password script 14
clearSortRules() method 81
CLI, command line interface 14
client URL library 65
command line interface (CLI) 14
commands for queries. See query strings
commit() method 73
comparison of XML grammars 28
comparison operators for fields 53
Compound Find
command 83
example 84
compound findquery command 49
query parameter 56
connecting to a FileMaker Pro database using PHP 72
container fields
how web users access data 17
progressive download 17
publishing contents of 15
URL syntax for accessing in XML solutions 26
with externally stored data 16
with referenced files 16
createRecord() method 73
creating a record
using PHP 73
using XML 50
cURL 65

Custom Web Publishingaccess to solutions by web users 13
definition 9
enabling in a database 13
enabling in Web Publishing Engine 14
extended privilege for 13
Guest account 14
new features in 21
overview 9
plug-ins for web publishing solutions 18
requirements for 21
restricting IP address access in web server 14
scripts 19
using a static IP address 22
using scripts 17
with PHP 11
with XML 11, 23
Custom Web Publishing Engine (CWPE) 24

D
database error codes 29, 97
database layouts available 50
database object 72
databases, protecting when published 14<datasource> element 30
date field 87
date representation 85–db query parameter 51–dbnames query command 47
Delete command 74–delete query command 47–delete.related query parameter 46
delete() method 74, 79
deleting a record 74
deleting portal records 46
document type definitions (DTDs) 29, 33
documentation, FileMaker product 8–dup query command 48
Duplicate command 73
duplicating a record 73
dynamic IP address 65

E
Edit command 74–edit query command 48
editing a record 74
elements
database error code 29
in FMPXMLLAYOUT grammar 35
in FMPXMLRESULT grammar 33
in fmresultset grammar 30
enabling Custom Web Publishing in a database 13

Index

encoding
PHP data 69
URLs 27
XML data 28, 38<error code> and <ERRORCODE> elements 97
errorsdatabase error code elements 29
database error code numbers 97
described 97
handling 90
log files for web server 94
examples ofgenerated FMPXMLLAYOUT grammar 37
generated FMPXMLRESULT grammar 34
generated fmresultset grammar 32
existing value validation 87
export XML data 23
extended privilege for Custom Web Publishing 13
Extensible Markup Language (XML). See XML

F
field name query parameter (non-container) 52
field names, fully qualified syntax 45–field query parameter (container) 52<field-definition> element 31–fieldname.op query parameter 53
fieldsattributes 31
calculation 28, 29
container 15, 26, 33
date 33, 36, 87
four-digit year 87
fully qualified field names 45
global 29
maximum number of characters 86
not empty 86
number 33
numeric only 86
portal 31
portals 45
related in PHP 78
related in XML 31, 45
repeating 27, 45
summary 28, 29
text 33
time 33, 36, 87
time of day 87
timestamp 33, 36, 87
FileMaker API for PHP 11
manual installation 66
reference 70
FileMaker class 71
FileMaker class objects
database 72
definition 71
record 73
related set 78

100

FileMaker command objects
Add 73Compound Find 83
Delete 74
Duplicate 73
Edit 74
Find 81, 82
Find All 82
Find Any 82
FileMaker Pro, contrast with Web Publishing Engine 23
FileMaker Server Admin Console 14
FileMaker Server documentation 8
FileMaker WebDirect 9
Filter portal records setting 58, 86
filtering portal field records 58
Find All command 82
Find Any command 82
Find command 82
Find command objects 81–find query command 49–findall query command 49–findany query command 49–findquery query command 49
fmphp keyword for enabling PHP publishing 13
FMPXMLLAYOUT grammar 23, 28, 35–37
FMPXMLRESULT grammar 23, 28, 33–34
fmresultset grammar 23, 28, 29–32
fmsadmin group 17
fmxml keyword for enabling XML publishing 13, 25
four-digit year field 87
four-digit-year attribute 31
fully qualified field name, syntax of 45

G
getContainerData() method 85
getContainerDataURL() method 85
getDatabase() method 77
getErrors() method 90
getFetchCount() method 85
getField() method 85
getFieldAsTimestamp() method 85
getFields() method 77, 85
getFoundSetCount() method 85
getLayout() method 77
getMessage() method 90
getName() method 77, 79
getRange() method 81
getRecords() method 85
getRelatedSet() method 78
getRelatedSets() method 78
getValueListsTwoFields() method 80
getValueListTwoFields() method 80
global fields
in field definition 31
syntax of 47
grammars for XML, described 28

Index

Guest accountdisabling 14
enabling 14
with Custom Web Publishing 14

Hhandling errors 90
homepage for PHP site 69
hostspec property for PHP 72
HTML forms for XML requests 25
HTTP directory for PHP 69
HTTPS 15
protocol in URL syntax 26
secure directory for macOS 66
with container fields 17
HTTPS directory for PHP 69

I
import XML data 23
in range validation 87
Initial row setting 58
installation of the FileMaker API for PHP 66
isError() method 90
isValidationError() method 89

Kkeywords for enabling Custom Web Publishing 13, 25

L
Latin-1 encoding 69–lay query parameter 40, 54–lay.response query parameter 40, 54–layoutnames query command 50
layoutsswitching for an XML response 40
use in PHP 77
limiting portal field records 59
listFields() method 77
listLayouts() method 77
listRelatedSets() method 77, 78
listScripts() method 75
listValueLists() method 77, 80
log files 92
described 94
Tomcat 96
web server access 94
web_server_module_log.txt 96–lop query parameter 55

MmacOS Server Admin 65
manual installation of the FileMaker API for PHP 66–max query parameter 55
max-characters attribute 31
maximum number of characters field 86

101

max-repeat attribute 31
member of value list validation 87<metadata> element 31
methods
add() 83
addSortRule() 81
clearSortRules() 81
commit() 73
createRecord() 73
delete() 74, 79
getContainerData() 85
getContainerDataURL() 85
getDatabase() 77
getErrors() 90
getFetchCount() 85
getField() 85
getFieldAsTimestamp() 85
getFields() 77, 85
getFoundSetCount() 85
getLayout() 77
getMessage() 90
getName() 77, 79
getRange() 81
getRecords() 85
getRelatedSet() 78
getRelatedSets() 78
getValueListsTwoFields() 80
getValueListTwoFields() 80
isError() 90
isValidationError() 89
listFields() 77
listLayouts() 77
listRelatedSets() 77, 78
listScripts() 75
listValueLists() 77, 80
newAddCommand() 73
newCompoundFindCommand() 83
newDeleteCommand() 74
newDuplicateCommand() 73
newEditCommand() 74
newFindAllCommand() 82
newFindAnyCommand() 82
newFindCommand() 82
newFindRequest() 83
newPerformScriptCommand() 75
newRelatedRecord() 79
numErrors() 89, 90
setLogicalOperator() 81
setPreCommandScript() 75, 81
setPreSortScript() 76, 81
setProperty() 72
setRange() 81
setRelatedSetsFilters() 86
setResultsLayout() 77
setScript() 76, 81
validate() 88
MIME (Multipurpose Internet Mail Extensions) types 15–modid query parameter 56
monitoring websites 94

IndexN
name attribute 31
namespaces for XML 28
new features in Custom Web Publishing 21–new query command 50
newAddCommand() method 73
newCompoundFindCommand() method 83
newDeleteCommand() method 74
newDuplicateCommand() method 73
newEditCommand() method 74
newFindAllCommand() method 82
newFindAnyCommand() method 82
newFindCommand() method 82
newFindRequest() method 83
newPerformScriptCommand() method 75
newRelatedRecord() method 79
non-empty field 86
not-empty attribute 31
Number of rows setting 58, 86
numbers for database error codes 97
numeric only field 86
numeric-only attribute 31
numErrors() method 89, 90O
online documentation 8
operators, comparison 53
order of XML request processing 41
out of memory error 18
overview
Custom Web Publishing 9
steps for XML data access 25

Pparameters for queries. See query strings
passwords
Basic Authentication for web users 13
Change Password script 14
defining for Custom Web Publishing 13
no login password 14
PDFs 8
performing find requests 81
PHP
Custom Web Publishing, described 11
enabling in a database 13
site homepage 69
supported version 66
PHP advantages 12
PHP version 65
plug-ins 18
portal field queries 58, 59

102

portals
adding records 45
deleting records 46
editing records 46
initial row 58
layout 58
number of records 58
sorting records 58
use in PHP 78
prevalidationcommands 86
date 87
fields 88
four-digit year 87
maximum number of characters 86
not empty 86
numeric only 86
records 88
time 87
time of day 87
timestamp 87
privilege set, assigning for Custom Web Publishing 13
processing a result set 85
processing a Web Publishing Engine request 10
progressive download 17
protecting published databases 14
publishing on the web
connecting to internet or intranet 22
container field objects 15
database error codes 97
protecting databases 14
requirements for 21
using XML 25

Q–query query parameter 56
query strings
adding records to portals 45
commands and parameters 38, 42
editing records in portals 46
fully qualified field name, syntax of 45
global fields, syntax of 47
guidelines for 43
requesting XML data 38, 42
querying portal fields 46

R–recid query parameter 57
record object 73

Indexrecords
creating in PHP 73
creating in XML 50
deleting in PHP 74
deleting in XML 47
duplicating in PHP 73
duplicating in XML 48
editing in PHP 74
editing in XML 48
finding in PHP 81
finding in XML 49
skipping in XML 62
reference information 70
related set object 78<relatedset-definition> element 31–relatedsets.filter query parameter 58–relatedsets.max query parameter 59
Re-Login script step 14
requests for XML data 25
requirements for Custom Web Publishing 21
result attribute 31
result set 85<resultset> element 31
retrieving
available script names 51
layout information 51
layout names 50

S
SAT. See FileMaker Server Admin Console–script query parameter 59
script triggers 19–script.param query parameter 60–script.prefind query parameter 60–script.prefind.param query parameter 60–script.presort query parameter 61–script.presort.param query parameter 61–scriptnames query command 51
scripts
accounts and privileges 18
in Custom Web Publishing 17
tips and considerations 18
use in PHP 75
use in XML requests 25
scripts steps
Change Password 14
Re-Login 14
security
accounts and passwords 14
documentation 10
guidelines for protecting published databases 14
restricting access from IP addresses 14
Server Admin tool. See macOS Server Admin
server requirements 64
setLogicalOperator() method 81
setPreCommandScript() method 75, 81
setPreSortScript() method 76, 81
setProperty() method 72

103

setRange() method 81
setRelatedSetsFilters() method 86
setResultsLayout() method 77
setScript() method 76, 81–skip query parameter 62–sortfield query parameter 62
sorting portal field records 58–sortorder query parameter 63
specifying layout when requesting XML data 40
SSL (Secure Sockets Layer) encryption 15
static IP address 65
static publishing, described 9
stylesheets, testing 92
summary of steps for XML data access 25
switching layouts for an XML response 40

T
testing
websites 92
XML output 93
text encoding
generated XML data 28
URLs 27
time field 87
time of day field 87
time-of-day attribute 31
timestamp field 85, 87
Tomcat, using log files 96
troubleshooting
Custom Web Publishing websites 92
XML document access 41
type attribute 31

U
UAC. See FileMaker Server Admin Console
Unicodecharacters used in XML parsers 38
data format returned by FileMaker Server 69
unique value validation 87
Unix timestamp 85
URL syntax forcontainer objects in XML solutions 26
XML requests 25
URL text encoding 27
user names
Basic Authentication for web users 13
defining for Custom Web Publishing 13
UTF-8 (Unicode Transformation 8 Bit) format 27, 38
UTF-8 encoding 69

Vvalidate by calculation 87
validate() method 88

Indexvalidationcommands 86
date 87
fields 88
four-digit year 87
maximum number of characters 86
not empty 86
numeric only 86
records 88
time 87
time of day 87
timestamp 87
value lists
use in PHP 80
use in XML 35–view query command 51

W
web browser’s role in XML requests 24
Web folder, copying container field objects 16
Web Publishing Core illustrated 24
Web Publishing Engine
application log 94
benefits of 20
described 10
generated error codes 97
generating XML data 24
generating XML documents 25
request processing 10
web server
log files 94
MIME type support 15
role in XML requests 24
web users
accessing protected databases 13
requirements for accessing Custom Web Publishingsolutions 21
using container field data 17
web_server_module_log.txt log file 96
websites
creating with Web Publishing Engine 20
monitoring 94
support pages 8
testing 92

104

X
XML
advantages 11
Custom Web Publishing, described 11
document type definitions (DTDs) 29, 33
enabling in a database 13
encoded using UTF-8 format 28, 38
FMPXMLLAYOUT grammar 35
FMPXMLRESULT grammar 33
fmresultset grammar 30<datasource> element 30<field-definition> element 31<metadata> element 31<relatedset-definition> element 31<resultset> element 31
generating XML data from request 24
grammars compared 28
namespaces for 28
order of request processing 41
parsers 25, 38
query strings 38, 42
request, specifying layout 40
requesting data 25
response, switching layout 40
summary of steps for accessing XML data 25
troubleshooting access to XML documents 41
URL text encoding 27
XML 1.0 specification 23<xsl:stylesheet> element 93<xsl:template> element 93