npm package: @proofgeist/n8n-nodes-filemaker-ottofms-data
Description: Execute FileMaker scripts via OttoFMS DataAPI Proxy
Author: Todd Geist
Latest version: 0.2.0

![Banner image](https://user-images.githubusercontent.com/10284570/173569848-c624317f-42b1-45a6-ab09-f0ea3c247648.png)

# n8n-nodes-filemaker-ottofms

This is an n8n community node. It lets you use FileMaker Server via OttoFMS DataAPI Proxy in your n8n workflows.

FileMaker Server with OttoFMS is a powerful database platform that provides REST API access through OttoFMS's DataAPI Proxy, enabling script execution and data management operations.

[n8n](https://n8n.io/) is a [fair-code licensed](https://docs.n8n.io/reference/license/) workflow automation platform.

[Installation](#installation)  
[Operations](#operations)  
[Credentials](#credentials)  
[Compatibility](#compatibility)  
[Usage](#usage)  
[Development](#development)  
[Resources](#resources)  
[Version history](#version-history)

## Installation

Follow the [installation guide](https://docs.n8n.io/integrations/community-nodes/installation/) in the n8n community nodes documentation.

## Operations

### Script Operations

- **Execute**: Execute FileMaker scripts with optional parameters and get results

### Future Operations (Planned)

- **Record Operations**: Create, read, update, and delete FileMaker records
- **Trigger Operations**: Poll for new/changed records and script completion webhooks

## Credentials

To use this node, you need:

### Prerequisites

1. FileMaker Server with OttoFMS installed and configured
2. OttoFMS DataAPI Proxy enabled
3. Valid OttoFMS Data API key (usually starts with `dk_`)
4. FileMaker database accessible via the DataAPI

### Authentication Setup

1. **Server URL**: Your FileMaker Server URL (without the `/otto` path)
   - Example: `https://filemaker.yourserver.com`
2. **API Key**: Your OttoFMS Data API key
   - Obtain from OttoFMS admin interface
   - Format: `dk_123456789...`
3. **Database Name**: FileMaker database name (without `.fmp12` extension)
4. **SSL Options**: Option to ignore SSL certificate validation for development

### Getting Your API Key

1. Access your OttoFMS admin interface
2. Navigate to the DataAPI section
3. Generate or copy your existing Data API key
4. Ensure the key has appropriate permissions for your database

## Compatibility

- **Minimum n8n version**: 1.0.0
- **Tested with**: n8n 1.x.x
- **Node.js**: 18.17.0 or higher
- **FileMaker Server**: 19.x or higher with OttoFMS
- **OttoFMS**: Latest version with DataAPI Proxy enabled

## Usage

### Basic Script Execution

1. Add the FileMaker OttoFMS node to your workflow
2. Configure your credentials (server URL, API key, database)
3. Select "Script" as the resource and "Execute" as the operation
4. Enter your script name (case-sensitive)
5. Optionally provide script parameters (JSON or plain text)

### Script Parameters

You can pass parameters to your FileMaker scripts in several ways:

- **Plain text**: Simple string values
- **JSON objects**: Complex data structures that will be stringified
- **n8n expressions**: Dynamic values from previous nodes

### Response Handling

The node returns:

- `success`: Boolean indicating if the script executed successfully
- `scriptResult`: The actual result returned by the FileMaker script
- `parsedResult`: JSON-parsed result (if parsing is enabled and result is valid JSON)
- `errorDescription`: Human-readable error description for failed executions

### Error Handling

The node provides detailed error information including:

- FileMaker error codes and descriptions
- Network and authentication errors
- Timeout handling for long-running scripts

## Development

See [DEVELOPMENT.md](DEVELOPMENT.md) for detailed development instructions.

### Quick Start

```bash
# Clone and setup
git clone <your-repo-url>
cd n8n-nodes-filemaker-ottofms
pnpm install

# Development with hot reload
pnpm run dev:hot

# Or manual build + start
pnpm run n8n:dev
```

### Project Structure

- `nodes/FileMakerOtto/` - Main node implementation
- `credentials/` - Authentication configuration
- `dist/` - Built files for distribution

## Resources

- [n8n community nodes documentation](https://docs.n8n.io/integrations/#community-nodes)
- [OttoFMS DataAPI Proxy Documentation](https://docs.ottofms.com/ottofms-features/api-proxy)
- [FileMaker OData Guide](https://help.claris.com/en/odata-guide/)
- [FileMaker Script Execution via OData](https://help.claris.com/en/odata-guide/content/run-scripts.html)

## Version history

### 0.1.0 (Current)

- Initial release with script execution functionality
- Support for FileMaker script execution via OttoFMS DataAPI Proxy
- Comprehensive error handling and response parsing
- Declarative node architecture for easy extensibility

### Planned Features

- Record CRUD operations
- Polling triggers for new/changed records
- Webhook triggers for real-time updates
- Advanced query capabilities