Data API Integration

We can use the Execute FileMaker Data API script step to harness the power of the @proofkit/fmdapi library in our webviewer integration.

• ✅ Use the same code and functions as in a browsed-based app
  • including typegen for a nice auto-complete experience and runtime validation for protection if field names are changed.
• ✅ No authentication required (it runs in the process of the logged in user)
• ✅ Works in offline FileMaker apps
• ✅ Works even if the Data API is disabled on the server

Setup

npm install @proofkit/fmdapi @proofkit/webviewer

export const config = {
  //  ...other config
  webviewerScriptName: "ExecuteDataApi",
};

Usage

Now you can use the DataAPI client just as you would in a browsed-based app!

import { UsersClient } from "./schema/client";

const users = await UsersClient.findOne({ query: { id: "===1234" } });

For examples of all methods, see the @proofkit/fmdapi documentation.

Batched Web Viewer Requests

WebViewerAdapter coalesces Data API calls that happen within a short window into one FileMaker script call by default. See Batching Data API Requests for per-request controls, tuning guidance, and add-on update requirements.

import { DataApi } from "@proofkit/fmdapi";
import { WebViewerAdapter } from "@proofkit/webviewer/adapter";

export const client = DataApi({
  adapter: new WebViewerAdapter({
    scriptName: "ExecuteDataApi",
    batch: {
      windowMs: 16,
      maxSize: 10,
    },
  }),
  layout: "API_Customers",
});

Default coalescing uses an 8 ms window and maximum batch size of 20. Use batch: false on the adapter or an individual request to send requests one at a time through the batch-compatible FileMaker script format. Benchmark with your own file before assuming batching improves speed; a local Execute FileMaker Data API script may see little benefit compared with a script that runs on FileMaker Server.

Adapter Pagination

For client.listAll() and client.findAll(), WebViewerAdapter does not send readAll or findAll actions to FileMaker. It sends a bounded first read request to get dataInfo.foundCount, then requests the remaining pages with the same limit.

If batching is enabled, those follow-up page requests can share FileMaker script calls. Each request is still a bounded read operation:

This keeps all-record helpers from loading an unbounded result set into FileMaker variables before anything is returned to the Web Viewer.