Custom Web Publishing Guide
Table Of Contents
- Chapter 1 Introducing Custom Web Publishing
- Chapter 2 Preparing databases for Custom Web Publishing
- Chapter 3 Accessing XML data with the Web Publishing Engine
- Using Custom Web Publishing with XML
- General process for accessing XML data from the Web Publishing Engine
- About the URL syntax for XML data and container objects
- Accessing XML data via the Web Publishing Engine
- Using the fmresultset grammar
- Using other FileMaker XML grammars
- 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
- Using server-side and client-side processing of stylesheets
- Troubleshooting XML document access
- Chapter 4 Introduction to Custom Web Publishing with XSLT
- Chapter 5 Developing FileMaker XSLT stylesheets
- Using XSLT stylesheets with the Web Publishing Engine
- About the FileMaker XSLT Extension Function Reference
- About the URL syntax for FileMaker XSLT stylesheets
- About the URL syntax for FileMaker container objects in XSLT solutions
- Using query strings in FileMaker XSLT stylesheets
- Specifying an XML grammar for a FileMaker XSLT stylesheet
- About namespaces and prefixes for FileMaker XSLT stylesheets
- Using statically defined query commands and query parameters
- Setting text encoding for requests
- Specifying an output method and encoding
- About the encoding of XSLT stylesheets
- Processing XSLT requests that do not query FileMaker Server
- Using tokens to pass information between stylesheets
- Using the FileMaker XSLT extension functions and parameters
- About the FileMaker-specific XSLT parameters set by the Web Publishing Engine
- Accessing the query information in a request
- Obtaining client information
- Using the Web Publishing Engine base URI parameter
- Using the authenticated base URI parameter
- Loading additional documents
- Using a database’s layout information in a stylesheet
- Using content buffering
- Using Web Publishing Engine sessions to store information between requests
- Using the session extension functions
- Sending email messages from the Web Publishing Engine
- Using the header functions
- Using the cookie extension functions
- Using the string manipulation extension functions
- Comparing strings using Perl 5 regular expressions
- Checking for values in a field formatted as a checkbox
- Using the date, time, and day extension functions
- Checking the error status of extension functions
- Using logging
- Using server-side processing of scripting languages
- Chapter 6 Testing and monitoring a site
- Appendix A Valid names used in query strings
- About the query commands and parameters
- Using the query commands
- -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
- -layoutnames (Layout names) query command
- -new (New record) query command
- -process (Process XSLT stylesheets)
- -scriptnames (Script names) query command
- -view (View layout information) query command
- Using the query parameters
- -db (Database name) query parameter
- -encoding (Encoding XSLT request) query parameter
- -field (Container field name) query parameter
- fieldname (Non-container field name) query parameter
- fieldname.op (Comparison operator) query parameter
- -grammar (Grammar for XSLT stylesheets) 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
- -recid (Record ID) 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
- -stylehref (Style href) query parameter
- -styletype (Style type) query parameter
- -token.[string] (Pass values between XSLT stylesheets) query parameter
- Appendix B Error codes for Custom Web Publishing
- Appendix C Converting CDML solutions to FileMaker XSLT
- About the process of converting CDML solutions to FileMaker XSLT solutions
- Conversion of CDML action tags, variable tags, and URLs
- Conversion of the -error and -errornum CDML variable tags
- Conversion of obsolete CDML action tags
- Conversion of supported CDML action tags
- Conversion of obsolete CDML variable tags
- Conversion of supported CDML variable tags
- Conversion of CDML boolean parameters to XPath boolean parameters
- Conversion of CDML boolean operators to XPath
- Conversion of CDML intratag parameters to XSLT-CWP
- Manually fixing CDML conversion errors
- Conversion of CDML replacement tags to XSLT-CWP
- Index
Chapter 5
|
Developing FileMaker XSLT stylesheets 63
Using content buffering
When content buffering is disabled, the Web Publishing Engine streams the result of an XSLT
transformation directly back to the client. Content buffering is always disabled unless you explicitly enable
it. If you enable content buffering, the Web Publishing Engine stores the transformed content until the entire
transformation is finished.
Content buffering is required for XSLT stylesheets that manipulate headers. Because headers are written
before the response body, the body must be buffered so that the added header information can be included.
There are four FileMaker extension functions that require the XSLT transformation result to be buffered:
1 fmxslt:create_session(): See “Using the session extension functions” on page 64.
1 fmxslt:set_header(): See “Using the header functions” on page 67.
1 fmxslt:set_status_code (): See “Using the header functions” on page 67.
1 fmxslt:set_cookie(): See “Using the cookie extension functions” on page 68.
In order for these FileMaker extension functions to work properly, you must include the following XSLT
processing instruction in the top level document for the request:
<?xslt-cwp-buffer buffer-content="true"?>
Important If you have a base stylesheet that includes another stylesheet, then the base stylesheet must
include the <?xslt-cwp-buffer?> processing instruction. This instruction is ignored if it is used in an included
stylesheet.
A benefit of using the processing instruction to buffer the response is that the Web Publishing Engine can
determine the length of the response and set the Content-Length header in the response. Buffering the
response might reduce the Web Publishing Engine’s performance.
Using Web Publishing Engine sessions to store information between requests
You can use the Web Publishing Engine’s server-side sessions to track and store any type of information
between requests. Sessions allow you to create a web application that is able to maintain state by using
persistent arbitrary pieces of information between requests. For example, user client information that is
entered on a first form page could be stored in a session and then used to populate values on a subsequent
page.
By default, the Web Publishing Engine will use a cookie to store the session ID. To accommodate clients
that do not allow cookies, you can use the
fmxslt:session_encode_url() function to add the Session ID to the
URL. To guarantee compatibility in all situations, it is recommended that you encode all URLs written out
to the page with the
fmxslt:session_encode_url() function. This function adds to your URL a semicolon-
separated parameter called
jsessionid, which is the identifier for the particular client’s parent session.
For example, instead of placing the following link on a page:
<a href="my_stylesheet.xsl?–db=products&–lay=sales&–grammar=fmresultset&–findall">hyperlinked text</a>
You should encode all links on a page as follows:
<a href="{fmxslt:session_encode_url('my_stylesheet.xsl?–db=products&–lay=sales&–grammar=fmresultset
&–findall')}">hyperlinked text</a>