1. Home
2. Components
3. Data Source Connectors
4. Databases
5. FileMaker

FileMaker

• Configuration
  • Prepare the FileMaker Database
  • Authorization Setup
  • Row Configuration
    • Object type
      • Metadata
      • Layout
• Output
  • Metadata Tables
    • layouts
    • layout_fields_metadata
  • Layouts Tables

FileMaker is a cross-platform relational database application from Claris International.

This component extracts layout data from FileMaker relational databases using the FileMaker Data API.

Configuration

Create a new configuration of the FileMaker data source connector.

Prepare the FileMaker Database

• Configure your database for FileMaker Data API access by creating specific layouts.
• Obtain FileMaker Data API credentials, including the host URL, username, and password.

Authorization Setup

Fill in the required authorization parameters:

• Host URL of the FileMaker server (base_url, required) – The FileMaker server host URL.
• User Name (username, required) – The username for authentication.
• Password (#password, required) – The corresponding password.
• Verify SSL certificate (ssl_verify, optional) – Set to false to disable SSL (https) certificate verification. Use with caution.

Save the configuration and click Add Row to create a new row configuration.

Row Configuration

Define the object type to extract and configure storage syncing options.

Object type

Metadata

Download schemas of selected layouts. Provide a list of Database and Layout names to retrieve metadata.

Note: Leave the list empty to retrieve metadata for all available objects.

Layout

Download data from a specific layout with a specified query.

Parameters:

• Database (database, optional) – The name of the FileMaker database.
• FileMaker layout name (layout_name, optional) – The name of the layout.
• Query Group (query, optional) – Groups of filter criteria.
  • The logical ‘OR’ operation is applied between groups.
  • The logical ‘AND’ operation is applied within a set of queries.
  • Note: If you include a field used for incremental fetching, the incremental fetching may not work as expected.
  • For more details on the syntax, see the FileMaker documentation.
• Load Type (incremental) – Defines how the result is stored in Keboola Storage:
  • Full load – Overwrites data in the destination on each run.
  • Incremental Update – Upserts data in the destination on each run.
• Primary key (pkey) – List of primary key columns, if available. Required for incremental load.
• Incremental fetching (incremental_fetch) – If true, only records with values >= to the last incremental field value will be retrieved in consecutive runs.
• Incremental fields (incremental_fields) – List of columns used for incremental fetching. If multiple specified, an AND relation is applied.
• Page size (page_size, optional) – The number of records retrieved per API call. Note: A large page size may impact performance on the destination database.

Output

Note: Columns prefixed with _ are stored in Keboola Storage with the hsh prefix in the resulting table. This is because Keboola Storage does not allow columns to begin with an underscore. For example, the column _Timestamp will be stored as hsh_Timestamp in the resulting table.

Metadata Tables

layouts

• List of available layouts.

Columns: [table, layout_name, parent_layout_name]

layout_fields_metadata

• Schema and metadata describing a specific layout.

columns: [ displayType, repetitionEnd, numeric, maxCharacters, maxRepeat, fourDigitYear, layout_name, database_name, type, repetitionStart, autoEnter, name, global, result, notEmpty, timeOfDay]

Layouts Tables

Layout data is extracted based on the query definition provided.