# Data Privacy URL: /docs/data-privacy *** title: Data Privacy description: What data is sent to AI providers, options available, and best practices to reduce exposure. --------------------------------------------------------------------------------------------------------- ## Summary * Purpose: Clarify what ProofChat sends to AI providers and how to control it * Audience: Implementers, security reviewers * Prereqs: See [/docs](/docs) ## What data is sent * Database schema: The schema as configured via DDL extraction and schema labeling, limited to the portions you include in configuration * User prompts: Anything typed into the chat input * Tool-shared data: Outputs from tools that you explicitly enable (e.g., summarized query results, component payloads) when necessary to refine SQL queries, searches, or otherwise improve the answer ## FileMaker Script Steps and Data Transmission FileMaker script steps that communicate with AI models may send data back to refine queries and improve responses. While it's technically possible to restrict this, it's practically challenging. Unless you're very familiar with how FileMaker communicates with large language models through its **Generate Response for Model**, **Perform SQL Query with Natural Language**, and **Perform Find with Natural Language** script steps, you should assume that some data will be sent to the models you have configured. If you'd like our help analyzing the specific configurations and tools you create with ProofChat, we can provide that service. See the [support page](/docs/support) for contact information. ## Ways to reduce exposure * Minimize context: Label only the schema and fields required; avoid sensitive fields unless strictly needed * Review your FileMaker script configurations carefully if data sensitivity is a concern ## Provider configuration * Prefer providers/models that meet your compliance needs * **Private Inference**: We can provide completely private infrastructure where you control the models and data never leaves servers under your control. Note that private inference is more expensive than using providers like OpenAI. Contact us via the [support page](/docs/support) to learn more. ## Related * Configuration → [AI Accounts and Models](/docs/integration/ai-accounts-and-models) * Configuration → [Schema Labeling](/docs/integration/schema-labeling) * Reference → [/docs/reference/settings/ai-accounts](/docs/reference/settings/ai-accounts) # Getting Started URL: /docs *** title: Getting Started description: Welcome to ProofChat documentation ----------------------------------------------- ## Introduction Welcome to ProofChat documentation! ProofChat seamlessly integrates AI chat into your FileMaker applications, enabling you to query data with natural language, generate insights, and create powerful workflows. ProofChat is now **production-ready** and available for free! Follow the steps below to get your license and start exploring AI capabilities in FileMaker. ## Step 1: Review Technical Requirements Before getting started, ensure your environment meets ProofChat's requirements: **[→ Review Technical Requirements](/docs/technical-requirements)** Key requirements include FileMaker 21+ and an OpenAI API key for chat functionality. ## Step 2: Get Your License Before you can use ProofChat, you'll need a license key. The good news is that ProofChat Free is available at no cost! ### Choose Your License Visit our [Pricing Page](/pricing) to select the license that's right for you: * **ProofChat Free** - Perfect for getting started and smaller deployments (up to 5) * **ProofChat Pro** - Coming soon! Join the waitlist for advanced features * **Enterprise** - Contact us for custom solutions **[→ Get Your License](/pricing)** ## Step 3: Download ProofChat After purchasing, you'll receive your license key via email along with a download link. You can also download ProofChat directly: → Download ProofChat The download includes a complete FileMaker file that serves two purposes: 1. **Ready-to-Use Demo**: A fully functioning example with ProofChat already set up and configured, including sample data. Perfect for exploring AI chat capabilities and seeing ProofChat in action. 2. **Integration Source Code**: All the ProofChat components, scripts, and layouts you need to copy into your own FileMaker solution. Our step-by-step integration guide walks you through the process. ## Step 4: Choose Your Path ### Option 1: Explore the Demo (Recommended for New Users) Follow these steps to explore ProofChat's capabilities with the demo file: 1. **Open the ProofChat demo file** to access the complete demo environment 2. **Open the chat interface** by clicking the chat button in the demo 3. **Activate your license** when prompted (this happens when you first open chat, not the file) 4. **Configure your OpenAI API key** when prompted after license activation 5. **Start chatting** with natural language queries using the sample data This path lets you experience ProofChat's full capabilities before deciding to integrate it into your own solution. ### Option 2: Direct Integration Ready to add ProofChat to your existing FileMaker solution? * Review our [Integration Process Overview](/docs/integration) for step-by-step guidance * Copy ProofChat components into your file following our documentation * **You'll activate your license after the integration is complete** * Future updates include upgrade paths (HTML and schema upgrades) ## Step 5: License Activation ProofChat will guide you through a quick setup process the first time you open the chat interface: * **If using the demo**: Open the chat button in the demo file to start the setup process * **If integrating directly**: Open the chat button after completing the integration steps The setup process includes: 1. **License activation** - Enter your license key to unlock ProofChat features 2. **OpenAI API key configuration** - Connect your AI provider for chat functionality This streamlined setup gets you chatting in just a few minutes! ## What ProofChat Offers * Query data with natural language * Generate insights from your database * Update records conversationally * Create powerful AI-driven workflows ## Next Steps * **Don't have a license yet?** [Get your free license](/pricing) to start using ProofChat * **Just downloaded ProofChat?** Open the demo file to explore features and activate your license * **Ready to integrate?** Review the [Integration Process Overview](/docs/integration) for complete step-by-step guidance *** *We're committed to regular updates and improvements. ProofChat includes upgrade paths to keep your integration current as we continue to enhance the platform. View our complete [Version History](/docs/guides/version-history) to see all releases and features.* # Support URL: /docs/support *** title: Support description: Comprehensive support options to help you succeed with ProofChat at every stage of your journey. ------------------------------------------------------------------------------------------------------------- ProofChat offers comprehensive support options to help you succeed at every stage of your journey, from getting started with the free license to implementing advanced enterprise solutions. ## Community Support **Available with:** Free License Community support provides access to comprehensive resources and peer-to-peer help through our dedicated community forum. ### What's Included * **Comprehensive Documentation**: Complete guides, tutorials, and reference materials with built-in AI-powered search * **Community Forum**: Ask questions and get answers from other ProofChat users and our team at [community.proof.sh](https://community.proof.sh/c/proofchat) * **Built-in AI Documentation Search**: ProofChat includes AI-powered search of our always up-to-date documentation * **Knowledge Base**: Comprehensive guides, tutorials, and troubleshooting resources * **Best Effort Response**: Our team monitors the community and provides help when possible ### Getting Started 1. Visit our [Community Forum](https://community.proof.sh/c/proofchat) 2. Search existing discussions or start a new topic 3. Use the built-in documentation search within ProofChat 4. Browse our comprehensive guides and tutorials ## Professional Services **Available with:** Pro or Enterprise License Get expert help with implementation, customization, and ongoing support from our team of ProofChat specialists. ### What's Included * **Implementation Support**: Expert guidance through your ProofChat integration process * **Custom Tool Development**: We'll build custom FileMaker scripts and tools for your specific needs * **Priority Bug Fixes**: Fast-track resolution of issues affecting your implementation * **Additional Pro Tools and Components**: Access to exclusive Pro-only tools and advanced components for enhanced functionality * **Dedicated Support Channel**: Direct access to our support team (Enterprise only) ### Prerequisites Professional services require an active ProofChat Pro or Enterprise license as the first step. This ensures you have access to the advanced features needed for complex implementations and gives us the resources to provide dedicated support. ## Frequently Asked Questions ### What support comes with the free license? Free license users have access to our community forum on [community.proof.sh](https://community.proof.sh/c/proofchat), comprehensive documentation with built-in AI search, and best-effort support from our team in the community space. ### How do I access professional services? Professional services require an active ProofChat Pro or Enterprise license. This ensures you have access to the advanced features needed for complex implementations and gives us the resources to provide dedicated support. ### When will ProofChat Pro be available? We're actively developing ProofChat Pro and will notify waitlist members as soon as it's ready. Join our [waitlist](/waitlist) to be among the first to know and get early access. ### What kind of professional services do you offer? Our professional services include: * Implementation support and consultation * Custom tool development for your specific FileMaker workflows * Priority bug fixes and feature requests * Ongoing consultation and optimization * Custom integrations with your existing systems * Training and onboarding for your team We work with you to ensure ProofChat meets your specific business needs and integrates seamlessly with your existing workflows. ### How do I get help with implementation? Before seeking help, ensure your environment meets our [technical requirements](/docs/technical-requirements). For **free license users**: Start with our documentation and community forum. Our comprehensive guides cover most common implementation scenarios. For **Pro/Enterprise users**: [Contact](/contact) our professional services team directly for personalized implementation support, custom tool development, and priority assistance. ### What's the difference between community and professional support? | Feature | Community Support | Professional Services | | -------------------- | ------------------ | ------------------------- | | Documentation Access | ✅ Full access | ✅ Full access | | Community Forum | ✅ Public forum | ✅ Plus priority responses | | Response Time | Best effort | Guaranteed SLA | | Custom Development | ❌ Not available | ✅ Available | | Priority Bug Fixes | ❌ Standard queue | ✅ Fast-track | | Implementation Help | ✅ Community-driven | ✅ Expert-led | | Dedicated Support | ❌ Not available | ✅ Enterprise only | ### How do I report bugs or request features? * **Community users**: Report bugs and request features through our [community forum](https://community.proof.sh/c/proofchat) * **Pro/Enterprise users**: Use your dedicated support channel for priority handling of bugs and feature requests ### Can I upgrade my support level? Yes! You can upgrade from community support to professional services by purchasing a Pro or Enterprise license. Contact us through the community forum or [join our waitlist](/waitlist) to be notified when Pro licenses become available. # Technical Requirements URL: /docs/technical-requirements *** title: Technical Requirements description: System requirements and limitations for running ProofChat successfully ----------------------------------------------------------------------------------- ## Overview ProofChat has specific technical requirements that must be met for proper functionality. Review these requirements before installation to ensure compatibility with your environment. ## FileMaker Version **FileMaker Version 22 or later is required.** ProofChat will not function on FileMaker versions prior to 22. ProofChat relies on features introduced in FileMaker 22. Earlier versions are not supported and will not work. ## Platform Compatibility ### FileMaker Pro **Fully supported.** ProofChat is optimized for FileMaker Pro and provides the best experience on desktop platforms. ### WebDirect **Not currently supported.** This version of ProofChat does not support WebDirect deployment. We are actively working on WebDirect compatibility for future releases. ### FileMaker Go **Limited support.** While ProofChat may function on FileMaker Go, it is not optimized for mobile platforms: * **iPad**: Generally works well due to larger screen size * **iPhone**: Not optimized for smaller screen sizes and may have usability issues * **Touch Interface**: Interface elements may not be fully optimized for touch interaction We are actively developing WebDirect support and improving mobile optimization. Future releases will expand platform compatibility. ## AI Provider Requirements ### Chat Functionality **OpenAI is currently required for chat functionality.** ProofChat's chat feature currently only supports OpenAI models due to technical limitations with tool calling implementation in FileMaker. * **Supported Models**: All current OpenAI chat models (GPT-4, GPT-3.5-turbo, etc.) * **API Key Required**: You must provide your own OpenAI API key * **Temporary Limitation**: Other AI providers (Anthropic, Google, etc.) are not currently supported for chat functionality This limitation is expected to be resolved in future versions of FileMaker. When FileMaker's tool calling implementation is updated, ProofChat will automatically support additional AI providers for chat functionality. ### Other AI Tools While chat functionality requires OpenAI, you can use different AI providers for custom FileMaker tools you develop: * **Flexibility**: Use any AI provider for your custom FileMaker scripts and tools * **Multiple Keys**: Different tools can use different API keys and providers * **Your Choice**: Mix and match providers based on your specific tool requirements ## API Key Requirements **ProofChat does not provide API keys.** You must obtain and manage your own API keys for all AI providers you use. ### What You Need * **OpenAI API Key**: Required for chat functionality * **Additional Keys**: Optional, for any other AI providers you use in custom tools * **Account Management**: Active accounts with sufficient credits/billing set up ### Security Considerations Since API keys are stored in FileMaker fields, proper FileMaker security is essential: * **FileMaker File Security**: Ensure your FileMaker file follows proper security practices since API keys are stored in database fields * **Access Control**: Use FileMaker privilege sets to restrict access to API key fields and related layouts * **File Encryption**: Consider FileMaker's encryption options for files containing sensitive API keys * **Environment Separation**: Use separate keys for development, staging, and production environments * **Key Rotation**: Follow your organization's key rotation and access policies * **Usage Monitoring**: Monitor usage and costs through your AI provider's dashboard ## Network Requirements * **Internet Connection**: Required for AI provider API calls * **HTTPS**: All API communication uses secure connections * **Firewall**: Ensure outbound HTTPS (port 443) access to AI provider endpoints ## Related Documentation * [AI Accounts and Models](/docs/integration/ai-accounts-and-models) - Setting up API keys and model selection * [Data Privacy](/docs/data-privacy) - Understanding what data is sent to AI providers * [Getting Started](/docs) - Complete setup guide * [Support](/docs/support) - Help with technical issues # Configuration Scripts Ownership URL: /docs/concepts/configuration-scripts-ownership *** title: Configuration Scripts Ownership description: After integration, you own the `ProofChat Integration` folder (Configuration + Custom Tools). The `ProofChat` folder remains owned by ProofChat and can be safely updated. --------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- ## Summary * **Purpose**: Make ownership boundaries explicit so you can upgrade without fear * **Audience**: Developers integrating and maintaining ProofChat in a FileMaker solution * **Prereqs**: [/docs/integration/](/docs/integration) ## Ownership at a glance The highlighted area shows what scripts you own after integration. ![Folder ownership: ProofChat Integration (yours) and ProofChat (ProofChat-owned)](../images/configuration-scripts.png) ## What you own (safe to edit) * **`ProofChat Integration/`** * **`Configuration/`**: Configuration scripts that ProofChat calls by name. These live in your file and are designed for you to edit. * **`Custom Tools Examples/`**: Example scripts and patterns you can copy, adapt, or replace with your own tools. Changes you make here are part of your solution and are preserved across updates. ## What ProofChat owns (do not edit) * **`ProofChat/`**: The application folder—UI, engine, and assets provided by ProofChat. Treat this as read‑only. Updates may replace files in this folder. ## How updates work * Your configuration scripts remain in place; ProofChat continues to call them by name. * Updating ProofChat may add, remove, or change files only in the `ProofChat/` folder. * Because your scripts live under `ProofChat Integration/`, upgrades should not overwrite your work. ## Naming contract (important) * Keep the provided configuration script names unless a page explicitly says otherwise. ProofChat locates these scripts by name. * If you rename or relocate scripts, update any references accordingly. ## Related * [Configuration Scripts](/docs/integration/configuration-scripts) - Main configuration documentation # Tools are Scripts URL: /docs/concepts/tools-are-scripts *** title: Tools are Scripts description: ProofChat tools invoke FileMaker scripts to perform actions and fetch data. ---------------------------------------------------------------------------------------- ## Summary * **Purpose**: Explain the tool model and how to create tools * **Audience**: Developers * **Prereqs**: [/docs](/docs) ## What Are Tools? Tools are FileMaker scripts that extend the AI assistant's capabilities. When a user asks a question that requires data retrieval, record operations, or external API calls, the AI can automatically call your configured tools to perform these actions. **The relationship**: Tool Name → FileMaker Script → AI Assistant Each tool configuration maps a tool name (used by the AI) to a FileMaker script (that performs the actual work). Tools can retrieve data, create or update records, call external APIs, and more—all triggered naturally through chat conversations. ## How Tools Work ### The Execution Flow 1. **User Query**: User asks a question like "Find all customers in California" 2. **AI Decision**: The AI analyzes the query and decides which tool(s) to use based on tool descriptions 3. **Script Execution**: ProofChat calls your FileMaker script with parameters extracted from the query 4. **Result Processing**: The script returns data via `Exit Script` 5. **Display**: Results are displayed either: * **Default (Text)**: Results are sent to the AI, which interprets them and crafts a natural language response * **Component**: Results are rendered directly using a predefined display component (table, chart, KPI card, etc.) ### Built-in vs User-Created Tools * **Built-in Tools**: System tools (like `get_weather`, `query_database`) that cannot be modified, only enabled/disabled * **User-Created Tools**: Custom tools you configure yourself with full control over all settings ## Script Requirements Your FileMaker scripts that act as tools should: * ✅ **Receive parameters via script parameter** (JSON format) * ✅ **Return results via Exit Script** (JSON format) * ✅ **Handle errors appropriately** (return error information in result) * ✅ **Keep layout stable** (use card windows if navigation needed, close them when done) * ✅ **Return data matching component format** (if using component display) Scripts can perform typical FileMaker actions: create/update/delete records, navigate to layouts, open card windows, process data, and call external APIs via Insert from URL, etc. ## Setting Up a FileMaker Script as a Tool Follow these steps to create a new tool: ### Step 1: Create Your FileMaker Script Create a FileMaker script that: * **Receives parameters**: Accepts JSON data via script parameter * **Performs the action**: Does the work (search, create, update, etc.) * **Returns results**: Uses `Exit Script` with JSON result * **Handles errors**: Returns error information in a consistent format **Example Script Structure**: ```javascript // FileMaker Script: HandleCustomerSearch // Receives JSON parameter: {"query": "John", "limit": 10} Set Variable [$param; Value: Get(ScriptParameter)] Set Variable [$query; Value: JSONGetElement($param; "query")] Set Variable [$limit; Value: JSONGetElement($param; "limit")] // Perform find Enter Find Mode [] Set Field [Customers::Name; "*" & $query & "*"] Set Error Capture [On] Perform Find [] // Build result JSON Set Variable [$result; Value: JSONSetElement("{}"; "success"; True; "count"; Get(FoundCount); "records"; JSONFromFile("...") )] Exit Script [$result] ``` ### Step 2: Configure Tool in Settings 1. Navigate to **Settings → Tools** (see [Tools Configuration](/docs/reference/settings/tools)) 2. Click **"Add Tool"** 3. Fill in **Basic Info**: * Tool Name: `search_customers` * Description: *"Searches for customer records by name. Use when users ask to find customers or look up contact information."* * Script Name: `HandleCustomerSearch` * Enabled: ✓ (checked) ### Step 3: Define Parameters In the **Parameters** tab: 1. Click **"Add Parameter"** 2. Configure: * **Name**: `query` * **Type**: String * **Description**: "Search term for customer name" * **Required**: ✓ 3. Add another parameter: * **Name**: `limit` * **Type**: Number * **Description**: "Maximum number of results to return" * **Required**: ✗ (optional) **Parameter Types**: * **String**: Text values * **Number**: Numeric values * **Boolean**: True/false values * **Object**: Nested objects (use dot notation for nested properties) * **Array**: Lists of values **Dot Notation for Nested Objects**: Use dot notation to define nested parameter structures: * `contact.first_name` → Creates nested object: `{ contact: { first_name: "..." } }` * `user.profile.email` → Creates deeper nesting: `{ user: { profile: { email: "..." } } }` When the AI calls your tool with nested parameters, they're passed to your FileMaker script as JSON in the script parameter. **Parameter Best Practices**: 1. Use descriptive names that clearly indicate purpose 2. Provide clear descriptions for each parameter 3. Use dot notation for logically grouped data 4. Mark parameters required only when essential 5. Use enums for constrained string values 6. Test your tool after configuring parameters ### Step 4: Choose Output Type In the **Output** tab: * **For simple data**: Choose **"Default (Text Response)"** - AI interprets and responds * **For structured data**: Choose **"Component Display"** and select appropriate component (e.g., `data-table`) If using a component, copy the expected format and ensure your script returns data in that exact structure. See [Tool Components](/docs/reference/tool-components) for available components and their expected formats. ### Step 5: Test Tool Execution 1. Save the tool configuration 2. Open a chat session 3. Ask a question that should trigger your tool: *"Find customers named John"* 4. Verify: * Tool is called with correct parameters * Script executes successfully * Results display correctly ## Use Cases ### Data Retrieval **Example**: "Find all customers in California" * **Tool**: `search_customers_by_state` * **Parameters**: `{ "state": "California" }` * **Output**: Component (Data Table) * **Script**: Performs find, returns records as table data ### Record Operations **Example**: "Create a new invoice for customer ID 123" * **Tool**: `create_invoice` * **Parameters**: `{ "customer_id": "123", "amount": 1500.00 }` * **Output**: Default (Text Response) or FileMaker Record component * **Script**: Creates record, returns confirmation ### Data Analysis **Example**: "Show sales summary by month" * **Tool**: `get_sales_summary` * **Parameters**: `{ "period": "monthly", "year": 2024 }` * **Output**: Component (Data Visualization or KPI Display) * **Script**: Aggregates data, returns formatted summary ### External API Calls **Example**: "Get weather for New York" * **Tool**: `get_weather` * **Parameters**: `{ "location": "New York" }` * **Output**: Component (Key-Value Display) * **Script**: Calls external API via Insert from URL, returns formatted data ### FileMaker Navigation **Example**: "Show me the details for customer John Doe" * **Tool**: `get_customer_record` * **Parameters**: `{ "name": "John Doe" }` * **Output**: Component (FileMaker Record) * **Script**: Finds record, returns record ID with navigation link ## When to Use Text vs Component Output ### Use Default (Text) when: * Results need AI interpretation and explanation * Data format doesn't match available components * You want conversational, natural language responses * Simple success/error messages **How it works**: Tool results are sent back to the AI model, which interprets them and crafts a natural language response. Example: A search tool returns raw data, and the AI explains "I found 5 customers matching your criteria..." ### Use Component Display when: * You want structured visualizations (tables, charts) * Data fits a predefined component format * Users need to interact with data (sort, filter, export) * Quick visual feedback is important **How it works**: Tool results are rendered directly using a predefined display component. No AI interpretation needed—the component displays the data immediately. ## Tool Configuration Details For detailed information about configuring tools in the Settings interface, see: * [Tools Configuration](/docs/reference/settings/tools) - UI reference for the Settings → Tools page * [Tool Components](/docs/reference/tool-components) - Available display components and their expected formats ## Related * [/docs/reference/settings/tools](/docs/reference/settings/tools) - UI reference for configuring tools * [/docs/reference/tool-components/](/docs/reference/tool-components) - Available display components * [/docs/integration/configuration-scripts/chat-tools](/docs/integration/configuration-scripts/chat-tools) - Advanced: Override tools per file via script # AI Script Editor URL: /docs/guides/ai-script-editor *** title: AI Script Editor description: Generate FileMaker scripts using AI and copy them directly to FileMaker clipboard. ----------------------------------------------------------------------------------------------- ## Summary * **Purpose**: Generate FileMaker scripts from natural language prompts and copy them directly to FileMaker clipboard * **Audience**: Developers, scripters * **Prereqs**: [AI Accounts and Models](/docs/integration/ai-accounts-and-models) configured, BaseElements plugin installed, Ottomatic AI Runtime enabled This feature is experimental and can make mistakes. Please double-check all generated scripts before using them in production. Always review the generated code for accuracy, security, and best practices. ## Overview The AI Script Editor allows you to generate FileMaker scripts by describing what you want in natural language. ProofChat's AI analyzes your request and generates a complete, well-commented FileMaker script that you can copy directly to your FileMaker clipboard and paste into Script Workspace. ![AI Script Editor Interface](../images/ai-script-editor.png) ## Requirements ### BaseElements Plugin The AI Script Editor requires the **BaseElements plugin** to copy scripts to FileMaker clipboard. The plugin provides clipboard functionality that allows ProofChat to set script steps directly on FileMaker's clipboard. **Installation**: Download and install BaseElements from the [BaseElements Plugin GitHub repository](https://github.com/GoyaPtyLtd/BaseElements-Plugin/blob/master/docs/README.md). BaseElements is a free FileMaker plugin that provides enhanced clipboard functionality and other utilities. The AI Script Editor uses BaseElements functions to copy generated scripts directly to FileMaker's clipboard format. ### Ottomatic AI Runtime The AI Script Editor **requires Ottomatic AI Runtime** to function. This runtime provides the necessary infrastructure for advanced features including automatic tool result submission, enhanced streaming, and server-side processing capabilities that enable the AI Script Editor to work seamlessly. **Why Ottomatic AI Runtime?** * **Automatic tool result submission**: Script generation results are automatically processed and submitted * **Advanced streaming**: Enhanced real-time processing for complex script generation * **Server-side capabilities**: Specialized processing required for FileMaker XML generation * **Multiple AI provider support**: Access to Anthropic, OpenAI, and more providers (coming soon) The AI Script Editor will not function with FileMaker Runtime. You must enable Ottomatic AI Runtime to use this feature. **To enable Ottomatic AI Runtime:** 1. Navigate to **Settings** → **[Chat Runtime](/docs/reference/settings/chat-runtime)** 2. Select **Ottomatic AI Runtime** 3. Click **Select** to activate 4. The application will reload with the new runtime **License Access:** Ottomatic AI Runtime is available on free licenses (25 requests per 24 hours) and ProofChat Pro (higher limits). See [Pricing and Licensing](/docs/guides/pricing-overview) for details. ## How It Works ### Basic Workflow 1. **Type your request**: In the ProofChat interface, describe the script you want to create (e.g., "Create a script that finds all customers in California and sets their status to active") 2. **AI generates the script**: ProofChat analyzes your request and generates a complete FileMaker script with proper formatting, comments, and error handling 3. **Review the script**: The generated script appears in a tool panel with syntax highlighting and line numbers 4. **Copy to FileMaker**: Click the **"Copy to FM"** button to copy the script directly to FileMaker's clipboard 5. **Paste in Script Workspace**: Open FileMaker Script Workspace, create a new script, and paste (Cmd+V / Ctrl+V) to insert the script steps ### Script Generation Features The AI Script Editor generates scripts that: * Follow FileMaker scripting best practices * Include helpful comments explaining what each section does * Handle errors appropriately * Use proper variable naming conventions * Include appropriate script step parameters ## Model Configuration (Optional) For optimal performance and cost efficiency, you can configure specialized models for the script generation process. These are optional—if not configured, ProofChat will use your "Main Chat" model. ### Available Model Purposes #### FM-Script-Step-Classifier **Purpose**: Classifies individual script steps to identify their type and structure. **Recommendation**: Use a smaller, faster, and more cost-effective model for this task. Classification is a simpler task that doesn't require the full capabilities of larger models. **Examples**: `gpt-4o-mini`, `gpt-3.5-turbo`, or similar smaller models #### FM-Script-Step-XML-Generator **Purpose**: Generates FileMaker XML clipboard format from script step text. **Recommendation**: Use a smaller, faster, and more cost-effective model for this task. XML generation follows a structured format that smaller models handle well. **Examples**: `gpt-4o-mini`, `gpt-3.5-turbo`, or similar smaller models ### Configuring Optional Models 1. Open ProofChat and navigate to **Settings → AI Accounts** 2. Scroll to **Model Assignments** (bottom of the page) 3. Find **FM-Script-Step-Classifier** in the list * Select your preferred provider (e.g., OpenAI) * Choose a smaller, faster model (e.g., `gpt-4o-mini`) 4. Find **FM-Script-Step-XML-Generator** in the list * Select your preferred provider (e.g., OpenAI) * Choose a smaller, faster model (e.g., `gpt-4o-mini`) 5. Save your changes If you don't configure these optional model purposes, ProofChat will automatically use your "Main Chat" model for script generation. This works fine but may be slower and more expensive than using specialized smaller models. ## Usage Examples ### Example 1: Simple Script Generation **Prompt**: "Create a script that finds all records where Status equals 'Active' and shows a count" **Result**: The AI generates a script with: * Enter Find Mode step * Set Field for Status * Perform Find * Show Custom Dialog with found count * Error handling ### Example 2: Complex Script with Variables **Prompt**: "Create a script that loops through found records, calculates a total, and sets a global variable" **Result**: The AI generates a script with: * Find logic * Loop structure * Variable calculations * Set Variable steps * Proper loop exit conditions ## Best Practices 1. **Always review generated scripts**: Even though the AI follows best practices, always review scripts before using them in production 2. **Test in a development environment**: Test generated scripts in a safe environment before deploying 3. **Be specific in your requests**: More detailed prompts lead to better script generation 4. **Use smaller models for classification/generation**: Configure the optional model purposes with smaller models to save costs and improve speed 5. **Keep BaseElements updated**: Ensure you're using a recent version of BaseElements plugin ## Troubleshooting ### "Copy to FM" Button Doesn't Work * **Check BaseElements installation**: Ensure BaseElements plugin is installed and enabled in FileMaker * **Verify script permissions**: The `setFMClipboard` script must be accessible and executable * **Check FileMaker version**: Ensure you're using FileMaker 21 or later ### Generated Scripts Have Errors * **Review the script**: Check for syntax errors or missing parameters * **Try rephrasing your prompt**: More specific prompts often yield better results * **Break complex requests into smaller parts**: Generate scripts in steps rather than one large script ### Model Configuration Issues * **Verify model assignments**: Check Settings → AI Accounts → Model Assignments * **Test model connection**: Ensure your AI provider account is connected and working * **Check model availability**: Verify the model you selected is available in your provider account ## Related * [AI Accounts and Models](/docs/integration/ai-accounts-and-models) - Configure AI models and providers * [Tools are Scripts](/docs/concepts/tools-are-scripts) - Understanding how tools work in ProofChat * [BaseElements Plugin Documentation](https://github.com/GoyaPtyLtd/BaseElements-Plugin/blob/master/docs/README.md) - BaseElements plugin reference # Custom Logo URL: /docs/guides/custom-logo *** title: Custom Logo description: Replace the ProofChat logo with your own logo in the chat interface. --------------------------------------------------------------------------------- ## Summary * **Purpose**: Customize the ProofChat chat interface with your own logo * **Audience**: ProofChat Pro and Enterprise users * **Prereqs**: ProofChat Pro or Enterprise license, access to FileMaker layouts Custom logo replacement is available for **ProofChat Pro** and **Enterprise** license holders only. Free license users will see the default ProofChat logo. ## Overview ProofChat Pro and Enterprise users can replace the default ProofChat logo with their own branding. This allows you to maintain consistent branding throughout your FileMaker solution and provide a more customized experience for your users. ## Steps ### Step 1: Navigate to the PC\_systems Layout 1. Open your FileMaker file that contains ProofChat 2. Go to **Layouts** → **Layout Mode** (or press Cmd+L / Ctrl+L) 3. Navigate to the layout named **`pc_systems`** (all lowercase) 4. This layout contains system configuration fields for ProofChat ### Step 2: Insert Your Logo 1. On the `pc_systems` layout, locate the field named **`logo`** (all lowercase) 2. Insert your logo image into the **`logo`** field: * You can drag and drop an image file into the field * Or use **Insert** → **Picture** and select your logo file * Or paste an image from your clipboard 3. Ensure your logo is properly sized and formatted for display For best results, use a logo that: * Has a transparent background (PNG format recommended) * **Maintains the correct aspect ratio** (approximately 3.5:1 width-to-height ratio, like 120px wide by 34px high) * Maintains good visibility at small sizes * Uses your brand colors effectively ### Step 3: Commit the Record 1. Commit your changes to save the logo data by clicking outside the field. ### Step 4: Reload the Chat 1. **Close the chat window** if it's currently open 2. **Reopen the chat** by clicking your "Open Chat" button or running the `Open Chat in new window` script 3. Your custom logo should now appear in the chat interface header ## Verification After reloading the chat, verify that: * Your logo appears in the chat interface header * The logo displays correctly (proper sizing, no distortion) * The logo is visible in both light and dark themes (if applicable) ## Troubleshooting ### Logo Doesn't Appear * **Check layout name**: Ensure you're editing the `pc_systems` layout (all lowercase, with underscore) * **Verify field name**: Confirm you inserted the logo into the field named **`logo`** (all lowercase) * **Commit the record**: Make sure you committed the record after inserting the logo (click outside the field) * **Reload chat**: Close and reopen the chat window completely ### Logo Appears Distorted * **Check image format**: Use PNG format with transparent background for best results * **Resize image**: Ensure your logo is appropriately sized (not too large or too small) * **Maintain aspect ratio**: Don't stretch or distort the original image dimensions ### Logo Not Updating * **Restart FileMaker**: Close and reopen FileMaker completely * **Verify license**: Confirm you have Pro or Enterprise license active * **Check field permissions**: Ensure the **`logo`** field allows data entry ## Best Practices 1. **Use high-quality images**: Start with a high-resolution logo and let ProofChat scale it appropriately 2. **Test in both themes**: Verify your logo looks good in both light and dark mode if you offer theme switching 3. **Keep it simple**: Simple logos with clear shapes work best at small sizes 4. **Maintain brand consistency**: Use the same logo file you use elsewhere in your solution ## Related * [License Management](/docs/guides/license-management) - Information about Pro and Enterprise licenses * [Open Chat Button](/docs/integration/open-chat-button) - How to add a button to open ProofChat * [Getting Started](/docs) - Initial ProofChat setup # Your First Query URL: /docs/guides/first-query *** title: Your First Query description: A quick path to your first successful ProofChat query. ------------------------------------------------------------------- ## Summary * Purpose: Get a fast win * Audience: New users ## Steps 1. Ensure AI accounts and models are configured ([AI Accounts and Models](/docs/integration/ai-accounts-and-models)) 2. Open the ProofChat window in your solution 3. Ask a simple question about a labeled table (e.g., “How many open tickets?”) 4. Inspect the result component (KPI card or table) ## Related * [/docs/reference/tool-components/](/docs/reference/tool-components) # License Management URL: /docs/guides/license-management *** title: License Management description: How to get, manage, upgrade, and deactivate ProofChat licenses. ---------------------------------------------------------------------------- ## Summary * **Purpose**: Guide users through the complete license lifecycle * **Audience**: ProofChat users at all levels * **Prereqs**: [Getting Started](/docs) ## Overview ProofChat offers flexible licensing options to meet your needs, from free usage to enterprise deployments. This guide covers everything you need to know about managing your ProofChat license throughout its lifecycle. ## Getting a License ### Free License The free version of ProofChat is available immediately with no license key required: 1. Visit the [Pricing Page](/pricing) 2. Click "Get Now" under the Free tier 3. Provide your email to receive the download link 4. Download includes the complete demo file and integration components 5. No license activation needed - start using ProofChat immediately ### Pro License (Coming Soon) The Pro version will include advanced features for professional developers: * Enhanced visualizations and analytics * Advanced tool development capabilities * Team collaboration features * Priority support **Note**: Pro licensing is currently in development. [Contact us](mailto:support@proof.sh) to be notified when it becomes available. ### Enterprise License For organizations requiring custom deployments, dedicated support, and enterprise features: 1. [Contact our sales team](mailto:info@proof.sh) to discuss your requirements 2. Receive a customized quote based on your needs 3. Work with our team to configure your enterprise deployment 4. Receive dedicated onboarding and support ## Managing Your License ### Checking License Status To view your current license information: 1. Open ProofChat in your FileMaker solution 2. Navigate to Settings → License Information 3. View your current plan, expiration date, and usage limits ### License Activation For paid licenses that require activation: 1. Receive your license key via email after purchase 2. Open ProofChat Settings → License Management 3. Enter your license key in the activation field 4. Click "Activate License" 5. Confirm activation was successful **Troubleshooting Activation Issues**: * Ensure you're connected to the internet * Verify the license key was copied correctly (no extra spaces) * Check that the license hasn't already been activated on another system * Contact support if issues persist ### License Transfer To move your license to a different FileMaker file or system: 1. Deactivate the license from the current system (see Deactivating Licenses below) 2. Install ProofChat on the new system 3. Activate the license using your original license key 4. Verify the transfer was successful **Important**: Each license can only be active on one system at a time. ## Upgrading Your License ### From Free to Pro When Pro becomes available: 1. Visit the [Pricing Page](/pricing) 2. Select the Pro plan and complete purchase 3. Receive your Pro license key via email 4. In ProofChat Settings → License Management, enter your new Pro key 5. Your account will be automatically upgraded with new features enabled ### From Pro to Enterprise To upgrade to Enterprise: 1. [Contact our sales team](mailto:info@proof.sh) 2. Discuss your enterprise requirements and receive a quote 3. Complete the enterprise agreement 4. Receive enterprise license and deployment assistance 5. Work with our team for seamless migration ### Mid-Cycle Upgrades If you upgrade before your current license expires: * Unused time on your current license will be credited toward the new plan * New features become available immediately upon activation * Billing will be prorated for the remainder of your billing cycle ## Deactivating Licenses ### When to Deactivate Deactivate your license when you need to: * Move ProofChat to a different FileMaker file * Transfer the license to another team member * Discontinue use of ProofChat * Troubleshoot activation issues ### How to Deactivate #### Option 1: From ProofChat Interface 1. Open ProofChat Settings → License Management 2. Click "Deactivate License" 3. Confirm deactivation in the dialog 4. License is immediately released for use elsewhere #### Option 2: Remote Deactivation If you can't access the original system: 1. Log into your account at [store.proof.sh/my-account](https://store.proof.sh/my-account) 2. Navigate to "My Licenses" 3. Find the license you want to deactivate 4. Click "Deactivate" next to the license 5. Confirm the deactivation #### Option 3: Contact Support If other methods don't work: 1. Email [support@proof.sh](mailto:support@proof.sh) 2. Provide your license key and reason for deactivation 3. Our team will deactivate the license within 1 business day ### After Deactivation Once deactivated: * ProofChat will revert to free functionality on the deactivated system * The license becomes available for activation elsewhere * No data is lost - all your configurations and chat history remain intact * You can reactivate the same license on the same or different system ## License Compliance ### Usage Monitoring ProofChat tracks license usage to ensure compliance: * User count (for multi-user licenses) * Feature usage (Pro vs Enterprise features) * System installations ### Compliance Best Practices * Only activate licenses on systems you own or manage * Deactivate licenses when no longer needed * Monitor user count to stay within license limits * Keep license keys secure and don't share them publicly ### Audit Support For enterprise customers, we provide: * Usage reports and compliance documentation * License audit assistance * Bulk license management tools * Custom compliance reporting ## Troubleshooting ### Common Issues **License Key Not Working** * Verify the key was copied correctly * Check for extra spaces or characters * Ensure the license hasn't expired * Confirm you're using the correct license type **Activation Failed** * Check internet connectivity * Verify the license isn't already active elsewhere * Try deactivating and reactivating * Contact support if the issue persists **Features Not Available After Upgrade** * Confirm the new license activated successfully * Restart FileMaker to refresh license status * Check that you're using the correct version of ProofChat * Verify the license includes the features you're trying to use ### Getting Help If you encounter license issues: 1. Check this troubleshooting section first 2. Review our [general troubleshooting guide](/docs/guides/troubleshooting) 3. Search our documentation for specific error messages 4. Contact [support@proof.sh](mailto:support@proof.sh) with: * Your license key (last 4 characters only) * Description of the issue * Screenshots if applicable * Steps you've already tried ## Related Topics * [Getting Started](/docs) - Initial setup and configuration * [Pricing](/pricing) - Current pricing and plan comparison * [Version History](/docs/guides/version-history) - Complete release history and version information * [Upgrade Guide](/docs/guides/upgrade-guide) - Managing ProofChat updates and migrations * [Data Privacy](/docs/data-privacy) - What data is shared with AI providers * [Troubleshooting](/docs/guides/troubleshooting) - General problem-solving guide # Pricing and Licensing Guide URL: /docs/guides/pricing-overview *** title: Pricing and Licensing Guide description: Understanding ProofChat licensing options and choosing the right plan for your needs ------------------------------------------------------------------------------------------------- This guide helps you understand ProofChat's licensing model and choose the right plan for your specific use case. For a detailed feature comparison, visit our [Pricing Page](/pricing). ## Overview ProofChat offers three license tiers designed to grow with your needs: * **Free**: Full-featured for anyone, including commercial use * **Pro**: For professional developers who need advanced features and white-labeling * **Enterprise**: For organizations requiring custom deployments and reseller rights ## Understanding License Tiers ### Free License The Free license is ideal for **anyone** who wants to use ProofChat, including: * Individual developers exploring AI capabilities in FileMaker * Commercial applications and products * Client solutions and deployments * Internal business applications * Demo files and samples **Important:** The Free license is truly free for ALL purposes, including commercial use and distribution. You can freely distribute your ProofChat-enabled solutions to customers - they just need to get their own free license. **Key Capabilities:** * Full AI chat integration * Data querying and analysis * Convert FileMaker scripts to AI tools * Human-in-the-loop workflows * Up to 5 deployments * All core visualization components * Community support with AI-powered documentation search * **Complete freedom to use commercially and distribute** **Constraints:** * ProofChat branding remains visible * Limited to OpenAI models only * No access to Pro-only tools * Cannot distribute your license (end users get their own) ### Pro License (Coming Soon) The Pro license is designed for: * Professional FileMaker developers * Client-facing applications * Solutions requiring a clean, branded interface * Teams needing professional support **Key Advantages over Free:** * Remove all Proof branding and advertisements * Access to multiple AI model providers * Purchase professional support hours * Priority bug fixes * Additional Pro-only tools and components ### Enterprise License The Enterprise license addresses: * Large-scale deployments across multiple servers * Organizations needing to resell ProofChat * Custom deployment requirements * Dedicated support needs **Unique Features:** * Unlimited deployments (custom pricing) * Reseller rights - include licensed ProofChat in your solutions * Dedicated Slack channel for support * Custom configurations and private inference options ## Key Concepts ### What is a Deployment? A deployment is a unique combination of: * One FileMaker file * One FileMaker Server (or FileMaker Pro desktop) **Examples:** * Same file on production, staging, and development servers = 3 deployments * Five different files on one server = 5 deployments * One file opened in FileMaker Pro on your laptop = 1 deployment (using your device's persistent ID) With 5 deployments in the Free license, you have flexibility for typical development workflows. ### Distribution Rights All license tiers allow you to include ProofChat in solutions you distribute, but there's an important distinction: **Free and Pro Licenses:** * You can freely include ProofChat in any distributed files or commercial solutions * The code can be distributed without restriction * End users must obtain their own ProofChat license (free is fine!) * You cannot distribute your license key * This model allows complete freedom for commercial distribution **Enterprise License with Reseller Rights:** * Include fully licensed ProofChat in your solutions * End users don't need separate ProofChat licenses * Ideal for commercial products and SaaS offerings ### AI Tools: Scripts as Capabilities ProofChat's power comes from turning your FileMaker scripts into AI tools. This means: * AI can execute specific database actions through your scripts * Responses are grounded in real data, not hallucinations * You control what capabilities the AI has access to * Human-in-the-loop tools require approval before execution Every script you designate as a tool becomes a capability the AI can use to interact with your database. ## Choosing the Right License ### Scenario 1: Individual Developer **You're exploring AI in FileMaker for personal projects or learning** * ✅ Start with the **Free** license * Download includes a complete demo file * Test with your own API keys * Upgrade to Pro when you need white-labeling ### Scenario 2: Consultant with Multiple Clients **You're building solutions for clients** * ✅ Start with **Free** for development * ✅ Upgrade to **Pro** for client deployments (removes branding) * Clients need their own licenses unless you have Enterprise with reseller rights ### Scenario 3: Software Product Company **You're building a FileMaker product to sell** * ✅ Consider **Enterprise** with reseller rights * Your customers won't need separate ProofChat licenses * Includes dedicated support for your team ### Scenario 4: Internal Enterprise Application **You're deploying across multiple departments/servers** * ✅ Start with **Free** if under 5 deployments * ✅ Consider **Enterprise** for unlimited deployments * Get dedicated Slack support channel ## Common Questions ### Can I use the Free license for commercial purposes? Absolutely! The Free license is truly free for ALL commercial purposes. You can: * Use it in production applications * Distribute it to unlimited customers * Include it in paid solutions * Deploy it for business-critical applications The only requirements are that ProofChat branding remains visible and end users get their own free licenses. ### Can I try before committing to Pro or Enterprise? Yes! The Free license includes all core functionality. You can fully test ProofChat's capabilities before upgrading. The main differences in paid tiers are branding removal, support options, and deployment limits. ### What if I distribute demo files? Demo files are perfect for the Free license. Your recipients can use the demo with their own free license and API keys. When they're ready for production, they can upgrade independently. ### Do I need a license for development and testing? Yes, but the Free license covers typical development scenarios with its 5 deployment limit. This usually covers development, testing, and production environments. ## Next Steps 1. **Getting Started**: [Download the free version](/pricing) and explore the included demo 2. **Integration**: Follow our [Integration Guide](/docs/integration) to add ProofChat to your solution 3. **License Management**: See our [License Management Guide](/docs/guides/license-management) for activation details 4. **Support Options**: Review available [Support Options](/docs/support) for each tier ## Related Resources * [Pricing Page](/pricing) - Detailed feature comparison * [License Management](/docs/guides/license-management) - Activation and management * [Integration Overview](/docs/integration) - Getting ProofChat into your solution * [Support Options](/docs/support) - Getting help when you need it # Troubleshooting URL: /docs/guides/troubleshooting *** title: Troubleshooting description: Common issues and how to resolve them. --------------------------------------------------- ## Symptoms and fixes * No response: Check network/API keys * Wrong data: Re-run DDL extraction and review schema labeling * Permission errors: Verify tool visibility and script access ## Related * [Version History](/docs/guides/version-history) - Check your current version and release information * [Upgrade Guide](/docs/guides/upgrade-guide) - Update and migration procedures * [DDL Extraction](/docs/integration/configuration-scripts/ddl-extraction) - Database schema configuration * [Schema Labeling](/docs/integration/schema-labeling) - Field-level configuration # Upgrade Guide URL: /docs/guides/upgrade-guide *** title: Upgrade Guide description: How to manage and install ProofChat updates for both HTML and FileMaker schema components. ------------------------------------------------------------------------------------------------------- ## Summary * **Purpose**: Guide users through ProofChat's update process * **Audience**: FileMaker developers and administrators * **Prerequisites**: Full access privileges in FileMaker ## Overview ProofChat is designed with a modular architecture that separates the HTML application from the FileMaker schema, allowing for flexible and safe updates. This guide explains how both types of updates work and how to manage them effectively. ## ProofChat Architecture ProofChat consists of two main components: ### 1. HTML Application * Runs inside a FileMaker web viewer * Contains the user interface and chat functionality * Updates automatically with a simple button press * No downtime required for updates * Tracks your current schema version automatically ### 2. FileMaker Schema * Database structure, scripts, and layouts * Updates require manual implementation * Includes migration guides when changes are needed * Updates are rare and carefully planned ## Update Types ### HTML Updates (Safe & Automatic) HTML updates are completely safe and can be applied immediately: **Characteristics:** * No FileMaker schema changes required * Zero downtime during installation * Automatic version compatibility checking * Only shows updates compatible with your current schema **When Available:** * Bug fixes and performance improvements * New features that don't require schema changes * Security updates * UI/UX enhancements ### Schema Updates (Planned & Guided) Schema updates require careful planning and provide detailed migration guides: **Characteristics:** * Requires manual implementation * Should be planned for minimal user disruption * Includes step-by-step migration instructions * Rare occurrences with advance notice **When Required:** * New features requiring database structure changes * Script modifications or additions * Layout updates * Major version upgrades ## Access Requirements ### Full Access Privileges Required **Important**: Only users with full access privileges can see and install updates. To check or install updates, you must: 1. Be logged into FileMaker with a full access account 2. Have administrative privileges in the ProofChat file 3. Be able to modify scripts and schema (for schema updates) **Why This Restriction Exists:** * Updates can modify critical system components * Ensures only authorized personnel can make changes * Prevents accidental modifications by end users * Maintains system security and integrity ## The Update Process ### Checking for Updates ProofChat automatically checks for available updates and displays them in the Updates section: 1. Open ProofChat in your FileMaker solution 2. Navigate to Settings → Updates 3. View available updates (if any) ### Understanding the Update Interface ![Complex Upgrade Example](../images/complex-upgrade.png) The update interface shows: **Current Version Information:** * Web Viewer App Version (your current HTML version) * FileMaker Schema Version (your current database schema) **Available Updates:** * **Safe Web Viewer Update**: Can be installed immediately * **FileMaker Schema Upgrade**: Requires administrator assistance and planning ### Installing HTML Updates When a safe HTML update is available: 1. **Review the Update Details** * Check what's included in the update * Note any new features or fixes * Verify compatibility with your schema 2. **Install the Update** * Click "Update Web Viewer Now (Safe)" * The update installs automatically * No user disruption occurs * New version becomes active immediately 3. **Verify Installation** * Check that the version number updated * Test core functionality * Verify new features are working (if applicable) ### Managing Schema Updates When a schema update is available: 1. **Review Requirements** * Read the migration path description * Understand what changes are needed * Plan for user downtime if necessary 2. **Plan the Migration** * Schedule the update during low-usage periods * Backup your FileMaker file before starting * Review the step-by-step migration guide * Ensure you have adequate time to complete the process 3. **Follow Migration Steps** * Each schema step must be migrated sequentially * Cannot skip migration steps (must go 0 → 1 → ... → 2) * FileMaker backup recommended before starting * Web Viewer updates become available after each schema migration 4. **Complete the Upgrade Sequence** * **Step 1**: Update Web Viewer (get latest features while keeping current schema) * **Step 2**: Plan FileMaker Migration (work with administrator to schedule upgrades) * **Step 3**: Enjoy Full Upgrade (access all new features after migration) ## Best Practices ### Before Any Update * **Backup First**: Always backup your FileMaker file before making changes * **Test Environment**: If possible, test updates in a development environment first * **User Communication**: Notify users of planned maintenance windows for schema updates * **Documentation**: Keep track of your current versions and update history ### HTML Updates * **Apply Promptly**: HTML updates are safe and should be applied when available * **Monitor Performance**: Watch for any unexpected behavior after updates * **Report Issues**: Contact support if you notice problems after an update ### Schema Updates * **Plan Carefully**: Schedule during low-usage periods * **Follow Sequence**: Complete migration steps in order * **Administrator Coordination**: Work with your FileMaker administrator * **Validate Results**: Test thoroughly after each migration step ## Troubleshooting Updates ### Update Not Appearing **Possible Causes:** * Not logged in with full access privileges * Already on the latest version * Network connectivity issues * License restrictions **Solutions:** 1. Verify you have full access privileges 2. Check your internet connection 3. Restart FileMaker and try again 4. Contact support if issues persist ### Update Installation Failed **For HTML Updates:** 1. Check internet connectivity 2. Verify sufficient disk space 3. Try the update again 4. Contact support if repeated failures occur **For Schema Updates:** 1. Ensure you followed migration steps in order 2. Verify you have full access privileges 3. Check that required scripts and layouts exist 4. Review the migration guide for missed steps 5. Contact support for assistance ### Post-Update Issues If you experience problems after an update: 1. **Document the Issue** * Note what functionality is affected * Record any error messages * Identify when the issue started 2. **Basic Troubleshooting** * Restart FileMaker * Clear browser cache (for web viewer issues) * Test with a different user account 3. **Contact Support** * Email [support@proof.sh](mailto:support@proof.sh) * Include your version numbers * Describe the issue and steps to reproduce * Attach screenshots if helpful ## Version History ProofChat maintains a complete version history that you can reference: * **Update Log**: View past updates and their contents * **Version Tracking**: See exactly which versions you've installed * **Rollback Information**: Understand what's involved in reverting changes (if needed) For a complete history of all ProofChat releases, see the [Version History](/docs/guides/version-history) page. ## Related Topics * [License Management](/docs/guides/license-management) - Managing your ProofChat license * [Troubleshooting](/docs/guides/troubleshooting) - General problem-solving guide * [Configuration Scripts](/docs/integration/configuration-scripts) - Initial setup and configuration * [Support](/docs/support) - Getting help when you need it # Version History URL: /docs/guides/version-history *** title: Version History description: Complete version history of ProofChat releases, including features, improvements, and upgrade information. ----------------------------------------------------------------------------------------------------------------------- ## Summary * **Purpose**: Track ProofChat releases, features, and changes over time * **Audience**: Administrators, developers, and users managing ProofChat installations * **Prerequisites**: Understanding of [ProofChat's versioning system](/docs/guides/upgrade-guide) ## Understanding ProofChat Versioning ProofChat uses a semantic versioning system with a special meaning for the first digit: **Version Format: `X.Y.Z`** * **X (Major)**: Database schema version - increments when FileMaker database structure changes are required * **Y (Minor)**: Feature releases - new functionality that doesn't require schema changes * **Z (Patch)**: Bug fixes, performance improvements, and minor updates ### Database Schema Upgrades When the first digit (major version) changes, it indicates that database schema modifications are required. These upgrades: * Must be performed manually by administrators * Include detailed migration guides * Should be planned during maintenance windows * Cannot be skipped (must upgrade sequentially: 0.x.x → 1.x.x → 2.x.x) For complete details on managing upgrades, see the [Upgrade Guide](/docs/guides/upgrade-guide). *** ## Release History Browse all ProofChat releases with detailed information about each version. Click on any version to see complete release notes, upgrade instructions, and download links. For complete details on all releases, visit the [Releases](/docs/releases) section. ### Latest Releases | Version | Release Date | Schema | Description | | ------------------------------ | ------------------ | ------ | ------------------------------------------------------- | | [3.0.1](/docs/releases/v3-0-1) | November 10, 2025 | 3 | Schema version update with field changes required | | [2.0.1](/docs/releases/v2-0-1) | October 7, 2025 | 2 | Schema update with script changes required | | [1.0.1](/docs/releases/v1-0-1) | October 6, 2025 | 1 | Major version with HTML improvements and schema updates | | [0.4.4](/docs/releases/v0-4-4) | September 25, 2025 | 0 | HTML-only update with guided OpenAI setup | | [0.4.3](/docs/releases/v0-4-3) | September 25, 2025 | 0 | Initial production release | Click any version number to view full release notes and download links. *** ## Related Documentation * **[Upgrade Guide](/docs/guides/upgrade-guide)** - Complete update and migration procedures * **[License Management](/docs/guides/license-management)** - Managing your ProofChat license * **[Integration Guide](/docs/integration)** - Adding ProofChat to your FileMaker solution * **[Configuration Scripts](/docs/integration/configuration-scripts)** - Setting up ProofChat functionality * **[Troubleshooting](/docs/guides/troubleshooting)** - Resolving common issues * **[Support](/docs/support)** - Getting help when you need it *** ## Stay Updated To stay informed about new ProofChat releases: * **Join our community** at [community.proof.sh](https://community.proof.sh/c/proofchat) * **Follow our documentation** for the latest guides and best practices * **Contact support** for enterprise update notifications and planning assistance *** *This version history will be updated with each ProofChat release. Bookmark this page to stay current with the latest features and improvements.* # AI Accounts and Models URL: /docs/integration/ai-accounts-and-models *** title: AI Accounts and Models description: Verify model assignments and configure additional AI providers in Settings → AI Accounts. ------------------------------------------------------------------------------------------------------ ## Summary * Purpose: Verify and configure model assignments, and optionally add additional AI providers beyond OpenAI * Audience: Admins, integrators * Prereqs: Complete [License Activation](/docs/integration/license-activation) and [OpenAI API Key Setup](/docs/integration/openai-api-key-setup) (OpenAI should already be configured), then see [/docs/reference/settings/ai-accounts](/docs/reference/settings/ai-accounts) * Primary Focus: **Model Assignments** - ensuring the right AI models handle different tasks in ProofChat ## Steps ### Primary Task: Verify Model Assignments 1. Open the Chat interface in the app 2. Choose Settings → AI Accounts (/docs/reference/settings/ai-accounts) 3. **Scroll to Model Assignments** (bottom of the page) - this is your main task 4. **Verify each assignment** has the correct provider (OpenAI) and model selected 5. **Confirm default models** for each purpose (e.g., Main Chat should use gpt-4o or similar) ### Optional: Verify OpenAI Connection 6. In the AI Provider Accounts table, confirm OpenAI shows "Connected" status 7. If needed, use Actions → Edit to verify your API key, then Actions → Test Connection Due to a known issue, the provider field in Model Assignments may be empty even when models are configured. You may need to manually select the provider (e.g., OpenAI) for each assignment, then confirm the model (gpt-4.1 should be the default) is properly selected. Model Assignments (at the bottom of the AI Accounts page) control which AI models handle different tasks in ProofChat. This is typically the main reason to visit this page after initial setup. You can change them any time without re‑adding API keys. ## Tips * Use separate keys per environment (dev/stage/prod) * Apply least‑privilege and rotate keys regularly * For Custom providers, confirm the base URL and model names match the vendor docs OpenAI is already configured from your initial setup. If you want to add Anthropic, custom endpoints, or other providers, use "Add Account" and follow the same steps to paste the key and test the connection. Then update your Model Assignments to use the new provider's models. For advanced configuration, you can set up optional model assignments for specific features like the [AI Script Editor](/docs/guides/ai-script-editor). See [Optional Model Assignments](/docs/reference/settings/ai-accounts#optional-model-assignments) in the AI Accounts reference for details. ## License and Model Access Your ProofChat license tier affects available AI models: * **Free**: Access to standard AI models with your API keys * **Pro**: Enhanced model selection and additional providers (Coming Soon) * **Enterprise**: Custom model configurations and private inference options Current license status is shown in Settings → License Management. ## Related * [OpenAI API Key Setup](/docs/integration/openai-api-key-setup) - Initial OpenAI configuration (previous step) * [Technical Requirements](/docs/technical-requirements) - API key and provider requirements * [License Management Guide](/docs/guides/license-management) - Complete license management information * [AI Script Editor](/docs/guides/ai-script-editor) - Generate FileMaker scripts with AI (uses optional model purposes) * [/docs/reference/settings/ai-accounts](/docs/reference/settings/ai-accounts) * [Chat Parameters](/docs/integration/configuration-scripts/chat-parameters) # Copy ProofChat into Your File URL: /docs/integration/copy-proofchat *** title: "Copy ProofChat into Your File" description: Step-by-step guide for integrating ProofChat by copying all components into your existing FileMaker solution ------------------------------------------------------------------------------------------------------------------------- ## Overview This guide walks you through the process of copying all ProofChat components into your existing FileMaker file. This approach allows you to maintain your current file structure while adding ProofChat's AI capabilities directly to your solution. Make sure you have your ProofChat license key available. You'll need it when you first open the chat after integration. Get your free license from our [Pricing Page](/pricing). Before starting this process, ensure you have: - A complete backup of your existing FileMaker file - Access to the ProofChat demo file - Administrative privileges in both files - Understanding of FileMaker's relationship graph and layout design ## Integration Steps ### Step 1: Copy Custom Functions First, you need to copy all custom functions from the ProofChat file into your target file. 1. **Open both files**: Have both your target file and the ProofChat file open in FileMaker Pro 2. **Access custom functions**: In the ProofChat file, go to `File > Manage > Custom Functions...` 3. **Copy custom functions**: Select all ProofChat custom functions and copy them 4. **Paste in target file**: In your target file, go to `File > Manage > Custom Functions...` and paste the copied functions 5. **Verify functions**: Ensure all custom functions are present and accessible ProofChat's custom functions may have dependencies on each other. Make sure to copy/paste all of them to avoid broken references. ### Step 2: Copy ProofChat Data Tables Next, copy all data tables that begin with `pc_` from the ProofChat file to your target file. 1. **Identify PC tables**: In the ProofChat file, go to `File > Manage > Database...` and note all tables with the `pc_` prefix 2. **Copy table structures**: * Select each `pc_` table in the ProofChat file * Copy the table structure (fields, field types, validation, auto-enter options) 3. **Create tables in target file**: In your target file, create new tables with identical structures * Maintain the exact `pc_` naming convention * Preserve all field definitions, types, and options * Ensure validation rules and auto-enter calculations are identical It's crucial that the table structures match exactly. Any differences in field types, validation, or auto-enter settings could cause ProofChat's AI functions to malfunction. ### Step 3: Recreate PC Table Relationships Recreate the relationships between the PC tables in your target file's relationship graph. 1. **Study ProofChat relationships**: In the ProofChat file, examine the relationship graph to identify connections between `pc_` tables 2. **Add table occurrences**: In your target file's relationship graph, add table occurrences for all `pc_` tables 3. **Recreate relationships**: Connect the table occurrences using the same relationship criteria as in the ProofChat file 4. **Verify relationship settings**: Ensure all relationship options (allow creation, deletion, sorting) match exactly Based on the current ProofChat structure, there should be minimal relationships between PC tables. However, verify this by carefully examining the ProofChat relationship graph. ### Step 4: Create ProofChat Layouts Create the basic layout structures for all ProofChat layouts in your target file. 1. **Identify ProofChat layouts**: In the ProofChat file, locate all layouts in the "ProofChat" folder (should be 7 layouts) 2. **Create layout folder**: In your target file, create a "ProofChat" folder in the layout list 3. **Create basic layouts**: For each ProofChat layout, create a new layout in your target file with: * The same name * The same base table occurrence * The same layout type (form, list, table, etc.) 4. **Initial setup only**: At this stage, just create the basic layout structure - don't worry about layout objects yet **ProofChat Layouts to Create:** ``` 📁 pc_ProofChat Layouts ├── 📄 pc_ProofChat ├── 📄 pc_ai_accounts_api ├── 📄 pc_chat_threads_api ├── 📄 pc_model_assignment_api ├── 📄 pc_model_assignment_account_api ├── 📄 pc_systems └── 📄 pc_tools_api ``` ### Step 5: Copy ProofChat Scripts Copy all scripts in the two specified folders from the ProofChat file to your target file. The two folders you're copying have different purposes: `ProofChat Integration` contains configuration scripts that you'll own and customize, while `ProofChat` contains the core application scripts that remain ProofChat-owned. See [Configuration Scripts Ownership](/docs/concepts/configuration-scripts-ownership) for details on what you can safely edit after integration. 1. **Access scripts**: In the ProofChat file, go to `Scripts > Script Workspace`. 2. **Select the folders**: Locate the folders named `ProofChat Integration` and `ProofChat` — these contain all ProofChat scripts. 3. **Copy**: Select both folders and copy them. 4. **Paste**: In your target file's Script Workspace, paste the copied folders. 5. **Keep folder structure**: Preserve the folder names `ProofChat Integration` and `ProofChat` to maintain organization. Scripts may contain references to layouts, table occurrences, or custom functions. We'll address any broken references in a later step. ### Step 6: Copy Layout Contents Now copy all layout objects and design elements from ProofChat layouts to your target file layouts. 1. **Work layout by layout**: For each of the 7 ProofChat layouts: 2. **Copy layout parts**: * Ensure header, body, footer, and any other parts match exactly * Copy part sizing and formatting 3. **Copy all layout objects**: Select all objects on the ProofChat layout and copy them 4. **Paste to target layout**: Paste all objects to the corresponding layout in your target file 5. **Verify object properties**: Check that all layout objects retain their: * Field assignments * Button actions and scripts * Formatting and styling * Conditional formatting * Object states and behaviors Pay special attention to button scripts, field assignments, and conditional formatting. These elements are crucial for ProofChat's functionality. ### Step 7: Import ProofChat Data Import all data from the `pc_` tables in the ProofChat file to your target file. 1. **Prepare for import**: Ensure your target file's `pc_` tables are empty and ready for data import 2. **Import data table by table**: For each `pc_` table: * Set up import from the ProofChat file * Map fields carefully to ensure data aligns correctly * Perform the import 3. **Verify data integrity**: After each import, verify that: * Record counts match * Data appears correctly in fields * Relationships function properly 4. **Test related data**: Ensure imported data maintains proper relationships between tables Carefully map fields during import to ensure data lands in the correct fields. Misaligned data could break ProofChat's functionality. ### Step 8: Review Field References Check for any broken references in field definitions. 1. **Review auto-enter calculations**: Check all fields in `pc_` tables for auto-enter calculations 2. **Verify calculation fields**: Ensure all calculation fields reference correct table occurrences and fields 3. **Check validation**: Verify field validation rules reference appropriate data 4. **Test field functionality**: Create test records to ensure all field behaviors work correctly ### Step 9: Review Script References Check for and fix any broken references in scripts. 1. **Test script functionality**: Run each ProofChat script to identify broken references 2. **Fix layout references**: Update any script steps that reference layouts to point to your newly created layouts 3. **Verify table occurrence references**: Ensure scripts reference the correct table occurrences in your file 4. **Update navigation**: Modify any navigation scripts to work within your file structure Systematically test each script to ensure it functions correctly in your target file environment. ## Verification Checklist After completing all steps, verify your integration: * [ ] All custom functions copied and accessible * [ ] All `pc_` tables created with identical structures * [ ] Relationships between `pc_` tables recreated correctly * [ ] All 7 ProofChat layouts created and populated * [ ] All ProofChat scripts copied and functional * [ ] All `pc_` table data imported correctly * [ ] No broken field references * [ ] No broken script references * [ ] ProofChat functionality accessible and working ## Next Steps Once you've completed this integration process: 1. **Connect your app**: Follow the [Add an "Open Chat" button](./open-chat-button) guide to connect your app to the chat 2. **Test thoroughly**: Create comprehensive tests to ensure all ProofChat features work correctly 3. **Train users**: Prepare training materials for users who will interact with ProofChat *** *This integration method requires careful attention to detail but results in a fully integrated solution with ProofChat capabilities built directly into your existing file.* # Experimental Add-On URL: /docs/integration/experimental-add-on *** title: Experimental Add-On description: Instructions for installing the experimental ProofChat FileMaker add-on using drag-and-drop installation --------------------------------------------------------------------------------------------------------------------- This add-on is **experimental**. If you encounter issues during installation or use, please use the [manual copy-based approach](/docs/integration/copy-proofchat) instead and share your feedback in our [community forum](https://community.proof.sh/c/proofchat). ## What is the Add-On? The ProofChat FileMaker add-on provides a drag-and-drop installation method that automatically imports all ProofChat components into your FileMaker solution. This experimental feature simplifies the integration process by eliminating the need to manually copy scripts, layouts, and components. ## Where to Find the Add-On The add-on is included in your ProofChat download package. After extracting the download, look for the **`addon/`** directory which contains: * **`ProofChat.fmaddon`** - Easy installation file (recommended) * **`ProofChat.zip`** - Manual installation archive (fallback option) ## Installation Methods ### Method 1: Easy Installation (Recommended) **For FileMaker Pro and FileMaker Pro Advanced:** 1. **Locate the add-on file:** * Navigate to the `addon/` directory in your ProofChat download * Find `ProofChat.fmaddon` 2. **Install the add-on:** * **Double-click** `ProofChat.fmaddon` * FileMaker Pro will automatically: * Install the add-on to the correct location * Make it available in the Add-on Modules menu 3. **Use the add-on:** * Open your FileMaker solution * Go to **File → Manage → Add-ons** (or **File → Manage → Modules** in some versions) * Find "ProofChat" in the list * Drag and drop it into your file **Note:** This method requires FileMaker Pro or FileMaker Pro Advanced. The add-on will be installed to: * **Mac:** `~/Library/Application Support/FileMaker/Extensions/AddonModules/` * **Windows:** `C:\Users\\AppData\Local\FileMaker\Extensions\AddonModules\` ### Method 2: Manual Installation (Fallback) If double-click installation doesn't work, use this manual method: 1. **Extract the zip file:** * Navigate to the `addon/` directory * Extract `ProofChat.zip` to a temporary location 2. **Copy to FileMaker Extensions directory:** * Copy the extracted **`ProofChat`** folder to your FileMaker Extensions directory: * **Mac:** `/Users//Library/Application Support/FileMaker/Extensions/AddonModules/` * **Windows:** `C:\Users\\AppData\Local\FileMaker\Extensions\AddonModules\` 3. **Restart FileMaker Pro:** * Close FileMaker Pro completely * Reopen FileMaker Pro * The add-on should now appear in your Add-on Modules menu 4. **Use the add-on:** * Open your FileMaker solution * Go to **File → Manage → Add-ons** (or **File → Manage → Modules**) * Find "ProofChat" in the list * Drag and drop it into your file ## After Installation Once the add-on is installed and added to your file: 1. **Complete the configuration steps:** * Follow [Step 2: Connect your app to the chat](/docs/integration/open-chat-button) * Complete [Step 3: License activation and OpenAI setup](/docs/integration/license-activation) * Verify [AI configuration](/docs/integration/ai-accounts-and-models) * Set up [database integration](/docs/integration/configuration-scripts) 2. **Test the installation:** * Open the chat using your configured button * Verify that all components are working correctly ## Troubleshooting ### Add-on doesn't appear after installation * **Check FileMaker version:** Ensure you're using FileMaker Pro or FileMaker Pro Advanced (not FileMaker Go or FileMaker WebDirect) * **Verify installation location:** Confirm the add-on folder is in the correct Extensions directory * **Restart FileMaker:** Close and reopen FileMaker Pro completely * **Check permissions:** Ensure you have write permissions to the Extensions directory ### Add-on installs but doesn't work correctly * **Use manual installation:** If the add-on causes issues, use the [manual copy-based approach](/docs/integration/copy-proofchat) instead * **Report the issue:** Share your experience in our [community forum](https://community.proof.sh/c/proofchat) so we can improve the add-on ### Drag-and-drop doesn't work * **Check FileMaker version:** Some older versions may not support drag-and-drop add-on installation * **Use manual copy method:** Follow the [copy-based integration guide](/docs/integration/copy-proofchat) instead ## Providing Feedback Since this add-on is experimental, your feedback is invaluable: * **Report issues:** Share any problems you encounter in our [community forum](https://community.proof.sh/c/proofchat) * **Suggest improvements:** Let us know what would make the add-on better * **Share success stories:** Tell us if the add-on worked well for your use case Your feedback helps us improve the add-on and make it production-ready! ## Next Steps After successfully installing the add-on: * [Add an "Open Chat" button](/docs/integration/open-chat-button) * [Activate your license](/docs/integration/license-activation) * [Configure OpenAI API key](/docs/integration/openai-api-key-setup) * [Set up database integration](/docs/integration/configuration-scripts) # Integration URL: /docs/integration *** title: Integration description: Overview of how to bring ProofChat into your FileMaker solution and configure it. Links to the step-by-step guide and configuration topics. -------------------------------------------------------------------------------------------------------------------------------------------------------- Before starting integration: 1. Review our [Technical Requirements](/docs/technical-requirements) to ensure compatibility 2. Ensure you have your ProofChat license key ready - get your free license from our [Pricing Page](/pricing) A FileMaker add‑on is now available in the download that lets you drag-and-drop ProofChat into any file. **This add‑on is experimental.** If you encounter issues with the add‑on, please use the manual copy-based approach below and complete the configuration steps. See the [Experimental Add-On installation guide](/docs/integration/experimental-add-on) for detailed instructions. We'd love your feedback—please share your experience in our [community forum](https://community.proof.sh/c/proofchat). ## What you'll do 1. Copy the ProofChat components into your existing file 2. Connect your application UI to the chat 3. Activate your license when you first open the chat 4. Configure your OpenAI API key 5. **Verify AI configuration** (confirm model assignments work) 6. **Configure database integration** (required for data queries) 7. Start using ProofChat with your data! **Optional enhancements:** * Customize chat behavior and suggestions * Add additional AI providers ## Step 1 — Copy ProofChat into your file Follow the step‑by‑step guide to import the ProofChat components and set up the basic structure in your solution. * [Copy ProofChat into Your File](/docs/integration/copy-proofchat) ## Step 2 — Connect your app to the chat Add a button in your app that calls the `Open Chat in new window` script. This script lives under `ProofChat → ProofChat Script API` and will open the chat window for users. * [Add an "Open Chat" button](/docs/integration/open-chat-button) ## Step 3 — Activate your license and configure OpenAI The first time you open ProofChat, you'll be prompted to enter your license key, then configure your OpenAI API key. * [License Activation](/docs/integration/license-activation) * [OpenAI API Key Setup](/docs/integration/openai-api-key-setup) ## Step 4 — Verify AI Configuration Confirm your AI setup is working correctly before proceeding: * [AI Accounts & Models](/docs/integration/ai-accounts-and-models) — Verify model assignments and test your AI connection ## Step 5 — Database Integration (Required) To connect ProofChat with your FileMaker database and enable data queries, you need to configure these essential components: * [Configuration Scripts](/docs/integration/configuration-scripts) — **Required**: Configure database integration and navigation * [Schema Labeling](/docs/integration/schema-labeling) — **Required**: Define which data ProofChat can access ## Next Steps ### After Database Integration * **Open the chat** and try asking questions about your data * **Test natural language queries** like "show me recent orders" or "find customers in California" * **Verify navigation** works by clicking on records in chat responses ### Fine-Tune Your Experience (Optional) * **Customize chat behavior** with system prompts and suggestions * **Add additional AI providers** beyond OpenAI if needed * **Review data privacy** guidance for sensitive information *** # License Activation URL: /docs/integration/license-activation *** title: License Activation description: Activate your ProofChat license when you first open the chat interface ----------------------------------------------------------------------------------- ## Overview After adding the "Open Chat" button to your FileMaker solution, the first time you click it, ProofChat will prompt you to enter your license key. This guide walks you through that activation process. ## When License Activation Happens License activation occurs automatically when you: 1. Complete the ProofChat integration steps 2. Add the "Open Chat" button to your solution 3. Click the chat button for the first time ProofChat will detect that no license is activated and prompt you to enter your license key. ## Getting Your License Key ### Free License If you haven't already: 1. Visit our [Pricing Page](/pricing) 2. Click "Get Now" under the Free tier 3. Complete the checkout process (no payment required) 4. Check your email for your license key ### Enterprise License Contact our [sales team](mailto:info@proof.sh) for your custom enterprise license. ## Activation Steps When you first open ProofChat, you'll see a license activation screen: ![ProofChat License Activation Screen](../images/enter-license.png) 1. **Enter License Key**: Paste your license key from the email into the "License Key" field 2. **Verify Information**: Confirm the license details are correct 3. **Activate**: Click the blue "Activate License" button 4. **Confirmation**: You'll see a success message when activation completes **Don't have a license yet?** Click the "Get License" button to be directed to our pricing page. Save your license key in a secure location. You'll need it if you move ProofChat to another file or need to reactivate. ## Troubleshooting ### License key not accepted? * Ensure you copied the entire key without extra spaces * Check that you're connected to the internet * Verify you're using the correct license key from your email ### Activation failed? * Try copying and pasting the key again * Check your internet connection * Contact [support@proof.sh](mailto:support@proof.sh) if issues persist ### Need to transfer your license? See our [License Management Guide](/docs/guides/license-management) for complete license management information. ## Next Steps Once your license is activated, you'll need to configure your OpenAI API key: 1. **Next**: Proceed to [OpenAI API Key Setup](/docs/integration/openai-api-key-setup) to configure your AI connection 2. After API key setup, you'll be ready to start chatting with ProofChat! 3. **Optional**: Visit [AI Accounts & Models](/docs/integration/ai-accounts-and-models) for advanced configuration 4. Configure your schema and scripts for enhanced functionality ## Related Topics * [OpenAI API Key Setup](/docs/integration/openai-api-key-setup) - Next step: Configure your AI connection * [License Management Guide](/docs/guides/license-management) - Complete license management including upgrades, deactivation, and troubleshooting * [AI Accounts & Models](/docs/integration/ai-accounts-and-models) - Advanced AI configuration and model assignments * [Troubleshooting](/docs/guides/troubleshooting) - General problem-solving guide # Add an "Open Chat" Button URL: /docs/integration/open-chat-button *** title: Add an "Open Chat" Button description: How to add a button in your FileMaker app that opens ProofChat using the `Open Chat in new window` script. ----------------------------------------------------------------------------------------------------------------------- ## Overview After you copy ProofChat into your file and complete configuration, you need a way for users to open the chat. The simplest approach is to call the `Open Chat in new window` script from a button in your solution. ## Where to find the script * Folder: `ProofChat → ProofChat Script API` * Script: `Open Chat in new window` This script ensures the required data is set up, then opens a new document window named `Chat` using the `ProofChat` layout. ## Add a button to your layout 1. Open the layout where users should access ProofChat. 2. Create a new button and label it, for example, "Open Chat". 3. Set the button action to `Perform Script`. 4. Choose `Open Chat in new window` from the `ProofChat → ProofChat Script API` folder. 5. Leave the parameter empty for the default behavior. That’s it—clicking the button will open the chat in a new window. ### What this looks like 1. Button setup on your layout ![Button setup calling your wrapper script](../images/open-chat-button-layout.png) 2. Your wrapper script (optional) just calls the API script ![Simple wrapper script calling Open Chat in new window](../images/open-chat-button.png) 3. The API script that opens the chat window ![Open Chat in new window in the ProofChat → ProofChat Script API folder](../images/opem-chat.png) ## Optional variations * Add the button to your main navigation so it’s always available. * Wrap the call in your own script (e.g., `Open Chat Button`) if you need to manage context first. * Use a custom icon or add keyboard shortcuts via your own scripting. ## Next Steps After adding the chat button to your solution: 1. **Test the button**: Click your new "Open Chat" button 2. **License activation**: The first time you open ProofChat, you'll be prompted to activate your license - see [License Activation](/docs/integration/license-activation) 3. **OpenAI setup**: After license activation, you'll configure your OpenAI API key - see [OpenAI API Key Setup](/docs/integration/openai-api-key-setup) 4. **Start chatting**: ProofChat will be ready to use immediately after these steps 5. **Optional configuration**: For advanced settings, visit [Configuration Scripts](/docs/integration/configuration-scripts) to customize ProofChat further When you first click the chat button, ProofChat will guide you through license activation and OpenAI API key setup before you can access the chat interface. ## Troubleshooting * If the chat window does not appear, confirm that the script exists in the `ProofChat → ProofChat Script API` folder. * Ensure the `ProofChat` layouts were copied and named correctly per the copy guide. * Run the script manually from Script Workspace to see any script errors. # OpenAI API Key Setup URL: /docs/integration/openai-api-key-setup *** title: OpenAI API Key Setup description: Configure your OpenAI API key to enable AI-powered conversations in ProofChat ------------------------------------------------------------------------------------------ ## Overview After successfully activating your ProofChat license, you'll be prompted to enter your OpenAI API key. This step enables AI-powered conversations and is required before you can start using ProofChat. ## When This Happens The OpenAI API key setup screen appears automatically when you: 1. Complete license activation successfully 2. ProofChat detects no OpenAI API key is configured 3. The system is ready to configure your AI connection ## Getting Your OpenAI API Key If you don't already have an OpenAI API key: 1. Visit the [OpenAI Platform](https://platform.openai.com/api-keys) 2. Sign up for an OpenAI account or log in to your existing account 3. Navigate to API Keys in your dashboard 4. Click "Create new secret key" 5. Copy the generated key (it starts with "sk-") 6. **Important**: Save this key securely - OpenAI won't show it again Your OpenAI account needs to have available credits or a payment method set up to use the API. Check your OpenAI billing settings if you encounter issues. ## Configuration Steps When ProofChat prompts you for your OpenAI API key, you'll see this screen: ![OpenAI API Key Required Screen](../images/open-ai-key.png) 1. **Enter OpenAI API Key**: Paste your complete API key (starts with "sk-") into the field 2. **Get API Key**: If you need to create one, click the "OpenAI Platform" link 3. **Save & Continue**: Click the blue "Save & Continue" button 4. **Ready to Chat**: ProofChat will load and be ready for your first conversation Your API key is stored securely in your FileMaker solution and is never shared with third parties, as noted at the bottom of the configuration screen. ## Troubleshooting ### API key not accepted? * Ensure you copied the complete API key (starts with "sk-") * Check for extra spaces at the beginning or end * Verify the key is active in your OpenAI account * Make sure you're connected to the internet ### "Invalid API key" error? * Confirm the key hasn't been revoked in your OpenAI account * Try generating a new API key from the OpenAI Platform * Check that your OpenAI account is in good standing ### Connection issues? * Verify your internet connection is stable * Check that your firewall isn't blocking OpenAI API requests * Ensure your OpenAI account has available credits * Contact [support@proof.sh](mailto:support@proof.sh) if issues persist ### Need to change your API key later? You can update your OpenAI API key anytime by visiting [AI Accounts & Models](/docs/integration/ai-accounts-and-models) in ProofChat settings. ## Next Steps Once your OpenAI API key is configured: 1. **Start chatting immediately** - ProofChat is now fully functional! 2. **Optional**: Visit [AI Accounts & Models](/docs/integration/ai-accounts-and-models) to verify model assignments or add additional AI providers 3. Configure your schema and scripts for enhanced functionality 4. Explore ProofChat's capabilities with your data ## Related Topics * [License Activation](/docs/integration/license-activation) - Previous step in the setup process * [AI Accounts & Models](/docs/integration/ai-accounts-and-models) - Advanced AI configuration and model assignments * [Technical Requirements](/docs/technical-requirements) - API key and provider requirements * [Troubleshooting](/docs/guides/troubleshooting) - General problem-solving guide # Schema Labeling URL: /docs/integration/schema-labeling *** title: Schema Labeling description: Best practices for labeling tables and fields so AI responses are accurate and safe. ------------------------------------------------------------------------------------------------- ## Summary * Purpose: Make schema AI-friendly without overexposing data * Audience: Integrators, data owners * Prereqs: [DDL Extraction](/docs/integration/configuration-scripts/ddl-extraction) ## Guidance * The DDL extraction looks for the "\[LLM]" tag in field comments. * Table behavior: * Whitelist mode: If any field in a table is tagged "\[LLM]", only fields tagged "\[LLM]" are exposed to the AI. * Open mode: If no fields are tagged "\[LLM]", all fields in the table are exposed. * Add brief descriptions to disambiguate field meaning. * Do not tag sensitive fields (PII, secrets) unless strictly necessary. * Prefer enumerations or tags for categorical fields. ### Example * If `Invoices::Total [LLM]` and `Invoices::Status [LLM]` are tagged but `Invoices::Notes` is not, the AI can access only `Total` and `Status`. ## Checklist * [ ] Only necessary tables/fields labeled * [ ] Ambiguity reduced with descriptions * [ ] Sensitive data excluded or summarized ## Related * [/docs/data-privacy](/docs/data-privacy) # Releases URL: /docs/releases *** title: Releases description: Browse all ProofChat releases and download specific versions. -------------------------------------------------------------------------- ## About ProofChat Releases This section contains detailed information about each ProofChat release, including release notes, upgrade instructions, and download links. Each version page provides comprehensive details about new features, bug fixes, and any required database schema changes. For information about ProofChat's versioning system and upgrade procedures, see the [Version History](/docs/guides/version-history) guide. *** ## All Releases ### Version 3.0.1 **Release Date**: November 10, 2025\ **Schema Version**: 3 Schema version update with field changes required. Includes a new ThreadMetaData field and Status field calculation update. [View Release Details →](/docs/releases/v3-0-1) *** ### Version 2.0.1 **Release Date**: October 7, 2025\ **Schema Version**: 2 Schema update with script changes required. Includes updates to the HTML retrieval script and database query tool. [View Release Details →](/docs/releases/v2-0-1) *** ### Version 1.0.1 **Release Date**: October 6, 2025\ **Schema Version**: 1 Major version update with HTML improvements, bug fixes, and database schema updates. Requires manual schema changes. [View Release Details →](/docs/releases/v1-0-1) *** ### Version 0.4.4 **Release Date**: September 25, 2025\ **Schema Version**: 0 HTML-only update providing a streamlined setup experience with guided OpenAI key setup. [View Release Details →](/docs/releases/v0-4-4) *** ### Version 0.4.3 - Initial Release **Release Date**: September 25, 2025\ **Schema Version**: 0 The initial production release of ProofChat, featuring natural language database queries and AI-powered chat interface. [View Release Details →](/docs/releases/v0-4-3) *** ## Related Documentation * **[Version History](/docs/guides/version-history)** - Understanding ProofChat versioning * **[Upgrade Guide](/docs/guides/upgrade-guide)** - Complete update and migration procedures * **[License Management](/docs/guides/license-management)** - Managing your ProofChat license * **[Support](/docs/support)** - Getting help when you need it *** ## Stay Updated To stay informed about new ProofChat releases: * **Join our community** at [community.proof.sh](https://community.proof.sh/c/proofchat) * **Follow our documentation** for the latest guides and best practices * **Contact support** for enterprise update notifications and planning assistance # Version 0.4.3 - Initial Release URL: /docs/releases/v0-4-3 *** title: Version 0.4.3 - Initial Release description: ProofChat version 0.4.3 release notes - The initial production release of ProofChat. ------------------------------------------------------------------------------------------------- Download **Release Date**: September 25, 2025\ **Schema Version**: 0 (Initial) This is the **initial production release** of ProofChat, marking the transition from beta to a stable, production-ready platform. ## Initial Release Highlights ### Core Features * **Natural Language Database Queries**: Query your FileMaker data using plain English * **AI-Powered Chat Interface**: Intuitive chat experience powered by OpenAI GPT models * **Seamless FileMaker Integration**: Native integration with FileMaker 21+ applications * **Record Navigation**: Click-to-navigate from chat results directly to FileMaker records * **Schema-Aware AI**: Automatically understands your database structure for accurate responses *** ## Related Documentation * **[Getting Started](/docs/guides/first-query)** - Your first query with ProofChat * **[Integration Guide](/docs/integration)** - Adding ProofChat to your FileMaker solution * **[Version History](/docs/guides/version-history)** - Overview of all ProofChat releases * **[Configuration Scripts](/docs/integration/configuration-scripts)** - Setting up ProofChat functionality * **[License Management](/docs/guides/license-management)** - Managing your ProofChat license * **[Support](/docs/support)** - Getting help when you need it # Version 0.4.4 URL: /docs/releases/v0-4-4 *** title: Version 0.4.4 description: ProofChat version 0.4.4 release notes - HTML-only update with guided OpenAI setup. ----------------------------------------------------------------------------------------------- Download **Release Date**: September 25, 2025\ **Schema Version**: 0 (No database changes required) HTML-only update providing a streamlined setup experience. ## New Feature * **Guided OpenAI Key Setup**: Added step-by-step process for entering your OpenAI API key immediately after license activation *** ## Related Documentation * **[Upgrade Guide](/docs/guides/upgrade-guide)** - Complete update and migration procedures * **[Version History](/docs/guides/version-history)** - Overview of all ProofChat releases * **[OpenAI API Key Setup](/docs/integration/openai-api-key-setup)** - Setting up your OpenAI API key * **[License Management](/docs/guides/license-management)** - Managing your ProofChat license * **[Support](/docs/support)** - Getting help when you need it # Version 1.0.1 URL: /docs/releases/v1-0-1 *** title: Version 1.0.1 description: ProofChat version 1.0.1 release notes - Schema version 1 with database changes required. ----------------------------------------------------------------------------------------------------- Download **Release Date**: October 6, 2025\ **Schema Version**: 1 (Database changes required) This release includes minor HTML updates, bug fixes, and important schema updates requiring database changes. Download the new version using the button above, and follow the instructions below to update your schema. After you have updated your schema, you can apply the HTML update. ## Schema Changes Required Four changes are required for this update: ### Script Changes 1. **Configure SQL Prompt Script**: Copy the "Configure SQL Prompt" script from the ProofChat demo file (located in ProofChat Integration Configuration Optional folder) into the same location in your file 2. **Tool Query Database Script**: Copy the entire contents of the "tool\_query\_database" script from the ProofChat download into the same script in your file 3. **Ensure Data Setup Script**: Copy the entire contents of the "Ensure ProofChat Data Setup" script from the ProofChat file to your file ### Field Modification 4. **pc\_system Table - Schema Number Field**: Update the calculation field "schema\_number" in the pc\_system table from `0` to `1` ## Updates * Minor HTML improvements * Bug fixes and performance enhancements * Database schema updates for enhanced functionality ⚠️ **Important**: This is a major version update requiring manual database schema changes. Please see the [Upgrade Guide](/docs/guides/upgrade-guide) for more information about schema migrations. *** ## Related Documentation * **[Upgrade Guide](/docs/guides/upgrade-guide)** - Complete update and migration procedures * **[Version History](/docs/guides/version-history)** - Overview of all ProofChat releases * **[License Management](/docs/guides/license-management)** - Managing your ProofChat license * **[Troubleshooting](/docs/guides/troubleshooting)** - Resolving common issues * **[Support](/docs/support)** - Getting help when you need it # Version 2.0.1 URL: /docs/releases/v2-0-1 *** title: Version 2.0.1 description: ProofChat version 2.0.1 release notes - Schema version 2 with database changes required. ----------------------------------------------------------------------------------------------------- Download **Release Date**: October 7, 2025\ **Schema Version**: 2 (Database changes required) This release includes 3 manual changes to your FileMaker solution. Download the new version using the button above, and follow the instructions below to update your scripts. ## Script Changes Required Two script changes are required for this update: 1. **'pc\_Get Latest HTML' Script**: Copy the entire contents of the "pc\_Get Latest HTML" script from the ProofChat download into the same script in your file 2. **'tool\_query\_database' Script**: Copy the entire contents of the "tool\_query\_database" script from the ProofChat download into the same script in your file ## Field Modification Required 1. **pc\_system Table - Schema Number Field**: Update the calculation field "schema\_number" in the pc\_system table from `1` to `2` ⚠️ **Important**: This is a schema version update requiring manual database schema changes. Please see the [Upgrade Guide](/docs/guides/upgrade-guide) for more information about schema migrations. *** ## Related Documentation * **[Upgrade Guide](/docs/guides/upgrade-guide)** - Complete update and migration procedures * **[Version History](/docs/guides/version-history)** - Overview of all ProofChat releases * **[License Management](/docs/guides/license-management)** - Managing your ProofChat license * **[Troubleshooting](/docs/guides/troubleshooting)** - Resolving common issues * **[Support](/docs/support)** - Getting help when you need it # Version 3.0.1 URL: /docs/releases/v3-0-1 *** title: Version 3.0.1 description: ProofChat version 3.0.1 release notes - Schema version 3 with database changes required. ----------------------------------------------------------------------------------------------------- Download **Release Date**: November 15, 2025\ **Schema Version**: 3 (Database changes required) > **Quick Check**: If you haven't customized your ProofChat file, you don't need to perform this upgrade. Simply download the new version, enter your license, and you're ready to go. These upgrade instructions are only necessary if you've integrated ProofChat into your custom FileMaker solution and have customizations you want to preserve. ## New Features * **Experimental Feature: AI Script Editor**: Generate FileMaker scripts using AI and copy them directly to FileMaker clipboard. This feature allows you to generate and edit FileMaker scripts automatically through AI assistance, making script development faster and more intuitive. Free tier: is limited to 25 requests per 24 hours. * **ProofChat Pro is now available**: ProofChat Pro is now available as a paid tier. This tier includes the unlimited access to the AI Script Editor and other Pro-only features. * **Ottomatic AI Runtime is now available**: Ottomatic AI Runtime is now available as a new runtime mode. This server-based runtime mode uses an external server to process AI requests with enhanced features and advanced streaming capabilities. * **Other Providers support**: Other providers support is now available. You can now use ProofChat with other providers such as Anthropic as well as OpenAI today. Many more providers are coming soon. This release includes schema updates and new scripts requiring manual database changes. Download the new version using the button above, and follow the instructions below to update your schema. ## Schema Changes Required Two field changes and one layout change are required for this update: ### New Field 1. **pc\_chat\_threads Table - ThreadMetaData Field**: Copy the new `ThreadMetaData` field from the `pc_chat_threads` table in the ProofChat download file to your custom file. ### Field Modification 2. **Schema Number Field**: Update the calculation field "schema\_number" in the pc\_system table changing the number in the calculation from `2` to `3`. ### Layout Modification 3. **pc\_systems Layout**: Copy the `pc_systems` layout from the ProofChat download file to the same layout in your custom file. ## Script Changes Required ### New Scripts Five new scripts are required for this update. Copy each script from the ProofChat download file to the same location in your custom file: 1. **confirm\_Execute** 2. **evaluateCalc** 3. **getFMClipboard** 4. **setFMClipboard** 5. **pc\_select\_web** ### Edited Scripts Three scripts have been updated. Copy the entire contents of each script from the ProofChat download file into the same script in your custom file: 1. **Chat\_Agent** 2. **Chat\_InitialProps** 3. **tool\_caller** ⚠️ **Important**: This is a schema version update requiring manual database schema changes. Please see the [Upgrade Guide](/docs/guides/upgrade-guide) for more information about schema migrations. *** ## Related Documentation * **[Upgrade Guide](/docs/guides/upgrade-guide)** - Complete update and migration procedures * **[Version History](/docs/guides/version-history)** - Overview of all ProofChat releases * **[License Management](/docs/guides/license-management)** - Managing your ProofChat license * **[Troubleshooting](/docs/guides/troubleshooting)** - Resolving common issues * **[Support](/docs/support)** - Getting help when you need it # Chat Parameters URL: /docs/integration/configuration-scripts/chat-parameters *** title: Chat Parameters description: Adjust model request parameters for the chat experience. --------------------------------------------------------------------- ## Summary * Purpose: Tune model behavior parameters used when generating responses * Audience: Integrators * Prereqs: [Configuration Scripts](/docs/integration/configuration-scripts) > Note: This script is for advanced use cases. Most teams can rely on the defaults set in Settings and never need to edit this. ## Steps 1. Open the FileMaker Script Workspace. 2. In `ProofChat Integration → Configuration → Optional`, edit the script named `Configure Chat Parameters`. 3. This script receives the current model name in `$model` and should set `$parameters` to a JSON object string. The default is `{}` (no overrides). 4. Optionally, branch on `$model` or other context to provide provider‑specific parameters as needed. 5. Exit the script by returning `$parameters`. ProofChat reads these values and passes them to the model request. ### What this looks like ![Configure Chat Parameters – return $parameters JSON string](../../images/chat-parameters.png) ## Guidance * Keep overrides minimal and documented so behavior remains predictable. * Make small, incremental changes and test with representative prompts. * Prefer global configuration in Settings; use this script only for temporary or context‑specific overrides. ### When to use this override * Enforce shorter or longer responses for a specific context (e.g., summaries vs. explanations). * Reduce repetition using provider‑specific penalties when drafting templated text. * Supply provider‑required flags or options for a particular model only. * Provide parameters only on specific layouts or for certain user roles. ## How to test it 1. Start a new chat and ask a question that benefits from concise output (e.g., "summarize this record in two sentences"). 2. Adjust a parameter in this script (e.g., response length or repetition penalty), start a new chat, and ask the same question; confirm the change in behavior. 3. Restore the previous value and confirm behavior returns to expected. ## Related * [Chat System Prompt](/docs/integration/configuration-scripts/chat-system-prompt) * [Chat Tools](/docs/integration/configuration-scripts/chat-tools) # Chat Suggestions URL: /docs/integration/configuration-scripts/chat-suggestions *** title: Chat Suggestions description: Configure starter suggestions shown in the chat interface. ----------------------------------------------------------------------- ## Summary * Purpose: Provide context-aware prompts users can click to get started * Audience: Integrators, admins * Prereqs: [Configuration Scripts](/docs/integration/configuration-scripts) ## Steps 1. Open the FileMaker Script Workspace. 2. In `ProofChat Integration → Configuration → Optional`, edit the script named `Configure Chat Suggestions`. 3. In the step `Set Variable [ $suggestionList ; Value: List( … ) ]`, click Specify… and enter your starter suggestions as a `List()` of strings. 4. Exit the script by returning `$suggestionList` as shown; ProofChat reads these values to populate the suggestion buttons in a new chat. 5. Save the script. No manual run is required—ProofChat applies it when chats start. #### Example `List()` you can paste ```text List( "find the last 10 invoices over 10,000", "list open support tickets assigned to me", "which products are low on inventory?" ) ``` ### What this looks like ![Configure Chat Suggestions – Set Variable $suggestionList as List("…")](../../images/chat-suggestion.png) ## Guidance * Keep suggestions specific to high‑value workflows. * Phrase suggestions as actions users want to perform (e.g., "find the last 10 invoices over 10,000"). * Keep them short; aim for 3-4 to start. * Update as business needs evolve. ## How to test it 1. Open the chat and start a new conversation. 2. Confirm your suggestions appear as clickable buttons. 3. Click one and verify it triggers the expected query/tool. # Chat System Prompt URL: /docs/integration/configuration-scripts/chat-system-prompt *** title: Chat System Prompt description: Configure the base instructions for the assistant. --------------------------------------------------------------- ## Summary * Purpose: Establish global guidance the assistant follows during chats * Audience: Integrators, admins * Prereqs: [Configuration Scripts](/docs/integration/configuration-scripts) ## Steps 1. Open the FileMaker Script Workspace. 2. In `ProofChat Integration → Configuration → Optional`, edit the script named `Configure Chat System Prompt`. 3. In the `Insert Text [ Select ; Target: $instructions ; "…" ]` step, click Specify… and enter your system prompt text. 4. Keep the rest of the script unchanged; ProofChat reads `$instructions` and applies it as the chat's base instructions. 5. Save the script. No manual run is required—ProofChat applies it automatically when chats start. ### What this looks like ![Configure Chat System Prompt – Insert Text to $instructions](../../images/system_prompt.png) ## Guidance * Keep the prompt short, directive, and solution‑specific. * Prefer imperatives and bullet points over long prose. * Avoid secrets or environment‑specific details; use configuration elsewhere if needed. * Document changes so teammates understand expected behavior. ## How to test it 1. Open the chat and ask a question twice: once with your prompt, once after removing a distinctive instruction (e.g., "answer concisely"). 2. Confirm that tone/formatting follows your system prompt (e.g., bullet answers, disclaimers, or style notes). 3. If changes don't appear, reload the chat and try again. ## Related * [Chat Parameters](/docs/integration/configuration-scripts/chat-parameters) * [/docs/concepts/configuration-scripts-ownership](/docs/concepts/configuration-scripts-ownership) # Chat Temperature URL: /docs/integration/configuration-scripts/chat-temperature *** title: Chat Temperature description: Configure the model temperature used for generating responses. --------------------------------------------------------------------------- ## Summary * Purpose: Set the temperature to influence determinism vs. creativity * Audience: Integrators * Prereqs: [Configuration Scripts](/docs/integration/configuration-scripts) > Note: This script is optional and typically for advanced use. Many teams can leave the default value. ## Steps 1. Open the FileMaker Script Workspace. 2. In `ProofChat Integration → Configuration → Optional`, edit the script named `Configure Chat Temperature`. 3. Set the `$temperature` variable to the value you want (e.g., `0.2` for deterministic, `1.0` for balanced, `>1` for more variety). 4. Exit the script by returning `$temperature`. ProofChat reads this value when starting a chat. ### What this looks like ![Configure Chat Temperature – return $temperature](../../images/chat_temperature.png) ## Guidance * Lower values produce more predictable, repeatable answers; higher values can be more diverse and creative. * Make changes gradually and validate with representative prompts from your users. * If you also use model‑specific overrides in `Chat Parameters`, let this temperature serve as the general default. ## How to test it 1. Start a new chat and ask a question twice, looking for variation (e.g., "draft three subject lines"). 2. Lower temperature, start a new chat, and ask again; results should be more similar each run. 3. Increase temperature, start a new chat, and ask again; outputs should vary more. ## Related * [Chat Parameters](/docs/integration/configuration-scripts/chat-parameters) * [Chat Tools](/docs/integration/configuration-scripts/chat-tools) # Chat Tools URL: /docs/integration/configuration-scripts/chat-tools *** title: Chat Tools description: Enable or disable tools that the assistant can call. ----------------------------------------------------------------- ## Summary * Purpose: Control which FileMaker scripts are exposed as tools * Audience: Integrators * Prereqs: [/docs/reference/settings/tools](/docs/reference/settings/tools) > Note: This script is for advanced use cases. Most teams will configure tools in Settings and never need to edit this script. ## Steps 1. Open the FileMaker Script Workspace. 2. In `ProofChat Integration → Configuration → Optional`, edit the script named `Configure Chat Tools`. 3. Leave the step that loads the default tools from Settings as‑is. It sets `$tools` to whatever you configured in Settings → Tools. 4. (Optional) Modify the `$tools` variable in this script to add, remove, or reorder tools for this file only. 5. Exit the script by returning `$tools`. ProofChat reads the text of this variable to determine which tools are available to the chat. ### What this looks like ![Configure Chat Tools – return $tools to override settings](../../images/tools-override.png) ## Guidance * Prefer configuring tools globally in Settings; use this script only when a file needs some specific override. ### When to use this override * Dynamically enable or disable tools based on the signed‑in user's role or permissions. * Toggle tools by environment (e.g., disable data‑changing tools in staging or demos). * Temporarily hide unstable or experimental tools without changing global Settings. ## How to test it 1. Open a chat and start a new conversation. 2. Call a tool you expect to be available; confirm it runs. 3. Temporarily remove a tool in the script override and start a new chat; confirm it no longer appears or runs. 4. Restore the original `$tools` and confirm behavior returns to normal. ## Related * [Chat System Prompt](/docs/integration/configuration-scripts/chat-system-prompt) * [Chat Suggestions](/docs/integration/configuration-scripts/chat-suggestions) # Configure SQL Prompt URL: /docs/integration/configuration-scripts/configure-sql-prompt *** title: Configure SQL Prompt description: Customize the system prompt used by ProofChat's database query tool to generate SQL statements. ------------------------------------------------------------------------------------------------------------ ## Overview The **Configure SQL Prompt** script allows you to customize the system prompt that guides ProofChat's AI when generating SQL queries for your database. This gives you control over SQL generation rules, syntax preferences, and query patterns specific to your FileMaker solution. This script is optional. If not implemented, ProofChat uses a default SQL prompt optimized for FileMaker's SQL dialect. ## When to Use This Script Consider implementing this script if you need to: * Enforce specific SQL syntax rules or conventions * Add custom business logic constraints to generated queries * Include solution-specific table or field naming patterns * Provide additional context about your data model * Restrict certain types of queries or operations ## Script Requirements ### Script Name ``` Configure SQL Prompt ``` ### Parameters * **None required** — This script takes no input parameters ### Return Value The script should return a **text result** containing your custom SQL prompt instructions. ## Implementation ![Configure SQL Prompt Interface](../../images/configure_sql_prompt.png) ### Basic Implementation ```text // Return your custom SQL prompt as text "You are an expert in FileMaker's version of SQL. Generate ONLY the SQL query - no explanations, comments, or additional text. CRITICAL RULES (MUST FOLLOW): - Always include qualified ROWID in SELECT statements: \"tablename\".ROWID - ROWID exception: Omit only when using aggregate functions (COUNT, SUM, AVG, etc.) - Use unquoted ROWID after the table name: \"invoices\".ROWID NOT \"invoices\".\"ROWID\" - Single queries only - no nested queries or subqueries SYNTAX RULES: - Enclose all table and field names in double quotes: \"table\".\"field\" - Date format: DATE 'YYYY-MM-DD' - Time format: TIME 'HH:MM:SS' - Timestamp format: TIMESTAMP 'YYYY-MM-DD HH:MM:SS' - Use FETCH FIRST n ROW ONLY instead of LIMIT - Use LIKE for pattern matching (case-sensitive, no ILIKE) - No semicolon at the end of the query" ``` ### Advanced Implementation For more sophisticated control, you can use any FileMaker scripting or calculation techniques to build dynamic prompts based on: * Current user context or permissions * Active layout or solution area * Environment variables or global settings * Business rules specific to different modules * Time-based or conditional logic Use standard FileMaker functions like `Case()`, `Let()`, `Get()` functions, custom functions, or even call other scripts to construct your prompt dynamically. The script can use any FileMaker scripting techniques, but should not change the current layout. ProofChat calls this script in the context of the user's current session. ```` ## Best Practices ### Keep It Focused - Focus on SQL generation rules, not general chat behavior - Be specific about FileMaker SQL dialect requirements - Include examples for complex patterns ### Business Logic Integration - Add context-specific rules based on current layout or user - Include data validation constraints - Specify required filters or security rules ### Testing Your Prompt 1. Implement the script with basic rules first 2. Test with various query types in ProofChat 3. Refine based on generated SQL quality 4. Add business-specific constraints as needed ## Common Use Cases ### Enforce Security Constraints ```javascript "Always include security filters: - Users table: Only show current user's records - Financial data: Require date range within last 5 years - Sensitive fields: Never include SSN or credit card fields" ```` ### Solution-Specific Patterns ```javascript "Table naming conventions: - All tables use 'tbl_' prefix - Junction tables use '_join_' pattern - Calculated fields end with '_calc' Always prefer these field names when available: - Use 'created_date' instead of 'date_created' - Use 'pk_id' for primary keys" ``` ### Performance Optimization ```javascript "Performance rules: - Always include indexed field constraints when possible - Limit results to 1000 rows unless specifically requested - Avoid queries on large text fields without WHERE clauses" ``` ## Troubleshooting ### Script Not Being Called * Verify the script name matches exactly: "Configure SQL Prompt" * Check that the script is accessible to the ProofChat user account * Ensure the script returns a text result, not empty ### Poor SQL Generation * Review your prompt for clarity and specificity * Test with simple queries first, then add complexity * Check FileMaker's calculation log for script errors ### Conflicting Rules * Avoid contradictory instructions in your prompt * Test edge cases where multiple rules might conflict * Prioritize critical business rules over style preferences ## Related Configuration * [Chat System Prompt](/docs/integration/configuration-scripts/chat-system-prompt) — Controls overall assistant behavior * [Chat Tools](/docs/integration/configuration-scripts/chat-tools) — Manages available tools including database queries * [DDL Extraction](/docs/integration/configuration-scripts/ddl-extraction) — Provides table structure information used in SQL generation # DDL Extraction URL: /docs/integration/configuration-scripts/ddl-extraction *** title: DDL Extraction description: How ProofChat extracts schema (DDL) and keeps it in sync. ---------------------------------------------------------------------- ## Summary * Purpose: Explain schema extraction and sync * Audience: Integrators * Prereqs: [/docs/integration/](/docs/integration) ## Steps 1. Open the FileMaker Script Workspace. 2. In the ProofChat Integration → Configuration → Required group, select and edit the script named "Configure DDL". 3. Click the "Tables..." step and choose the tables you want included in the DDL. 4. Save the script. You do not need to run it manually; ProofChat calls it just‑in‑time when needed. ### What configuring the DDL looks like ![Configuring DDL in FileMaker Script Workspace](../../images/ddl.png) The screenshot shows the "Configure DDL" script with the "Tables..." selection dialog open. ## How it works * ProofChat reads table/field metadata and relationships to construct a DDL summary * The DDL is used to give the model enough structure to answer questions accurately * The extraction script runs on‑demand just before ProofChat needs it, so you don't have to manually re‑run anything during normal use This step controls which tables are included in the DDL. To configure which fields within those tables are exposed to the AI, use Schema Labeling. See: [Schema Labeling](/docs/integration/schema-labeling) ## Keeping it current * You do not need to re‑run extraction after schema edits; it runs automatically when needed * Renames are fine — the script reads the live schema each time * The only thing you need to maintain here is the table selection: keep the checklist aligned with what you want the AI to see * Exclude tables you don't want exposed; include only what is needed * Field‑level inclusion/exclusion is handled in Schema Labeling: [Schema Labeling](/docs/integration/schema-labeling) ## Related * [Schema Labeling](/docs/integration/schema-labeling) # Configuration Scripts URL: /docs/integration/configuration-scripts *** title: Configuration Scripts description: Overview of configurable FileMaker scripts used by ProofChat, with required/optional status and links to details. ------------------------------------------------------------------------------------------------------------------------------ ## Overview These FileMaker scripts control how ProofChat integrates with your solution. Complete the required scripts first, then optionally tune the others. Run through required scripts in this order: DDL Extraction → Navigation Script Hooks. Then adjust any optional scripts as needed. ## Required Scripts * [DDL Extraction](/docs/integration/configuration-scripts/ddl-extraction) — Extracts and syncs DDL metadata used by ProofChat * [Navigation Script Hooks](/docs/integration/configuration-scripts/navigation-script-hooks) — Enables navigation back to records/layouts in your app ## Optional Scripts * [Chat System Prompt](/docs/integration/configuration-scripts/chat-system-prompt) — Configure the base instructions for the assistant * [Chat Suggestions](/docs/integration/configuration-scripts/chat-suggestions) — Manage quick-start suggestions shown in chat * [Chat Tools](/docs/integration/configuration-scripts/chat-tools) — Override the default tools exposed to the assistant * [Chat Parameters](/docs/integration/configuration-scripts/chat-parameters) — Provide advanced, context‑specific model request parameters * [Chat Temperature](/docs/integration/configuration-scripts/chat-temperature) — Set the default temperature for responses * [Configure SQL Prompt](/docs/integration/configuration-scripts/configure-sql-prompt) — Customize the system prompt used for generating SQL queries ## Next steps Work through the two required scripts, verify end-to-end navigation and DDL availability, then iterate on optional scripts to tune your experience. # Navigation Script Hooks URL: /docs/integration/configuration-scripts/navigation-script-hooks *** title: Navigation Script Hooks description: Edit configuration scripts so ProofChat can navigate back into your solution. ------------------------------------------------------------------------------------------ ## Summary * Purpose: Enable round-trip navigation from ProofChat to target layouts/records * Audience: Integrators * Prereqs: [/docs/integration/](/docs/integration) ## Steps 1. Open the FileMaker Script Workspace. 2. In `ProofChat Integration → Configuration → Required`, edit the script named `Configure Navigate To Record`. 3. In the step `Set Variable [$layoutName; Value: …]`, click Specify… and edit the `Case( )` mapping that translates a table name to a layout name. 4. Map table names to layout names (e.g., `products → "ProductView"`, `customers → "CustomerView"`). Keep mappings on a single `Case( )` for easy maintenance. 5. Keep the rest of the script as‑is; it handles window selection, opening the layout, and navigating to the requested record index. 6. Save the script. The script includes a step that selects your main application window by name. If your primary window is not named "Main", change the `Select Window` step to match your window name. ```text # you may need to change this to select your Main application's window Select Window [ Name: "Main" ; Current file ] ``` If the specified window is not found, the script opens a new one automatically. #### Example mapping ```text Case( $tableName = "products"; "ProductView"; $tableName = "customers"; "CustomerView"; $tableName = "contacts"; "ContactView"; $tableName = "invoices"; "InvoiceView"; "" // fallback: empty triggers the "No Layout" dialog ) ``` ### What this looks like ![Configure Navigate To Record script mapping tables to layouts](../../images/navigate_to_record.png) ## How to test it To verify navigation works end‑to‑end, trigger it from the chat UI (not by running the script manually): 1. In Chat, ask a question that uses the Query Database tool for one of your mapped tables (e.g., "Show the latest invoices"). 2. When the result renders as a data visualization table or a FileMaker record custom component, click a row or the record link. 3. ProofChat will call `Configure Navigate To Record` with the table name and record identifiers, switch to your file, and open the mapped layout at the selected record. 4. If the table isn't mapped or the mapping returns an empty layout, you'll see the "No Layout" dialog from the script. ## Advanced customizations This script is yours to tailor. Beyond a simple table→layout mapping, you can: * Route different users to different layouts based on privilege set, account name, or any condition. * Send different categories of records to different layouts (e.g., inventory vs. service items). * Apply business rules before navigating (e.g., open in a new window, show a warning, or log access). * Derive the destination layout dynamically from the record, settings table, or conventions. Goal: ensure the user lands on the layout you intend for the record they clicked in the chat UI. The script receives the table name, record ID(s), and the selected record index as parameters, so you have the context you need. Because configuration scripts belong to your solution, you can modify them safely. See ownership details: [/docs/concepts/configuration-scripts-ownership](/docs/concepts/configuration-scripts-ownership). ## Related * [/docs/reference/settings/tools](/docs/reference/settings/tools) # AI Accounts URL: /docs/reference/settings/ai-accounts *** title: AI Accounts description: Manage provider accounts, API keys, and default models. -------------------------------------------------------------------- ## Summary * Purpose: Central place to configure providers and models * Audience: Admins * Prereqs: [/docs/integration/](/docs/integration) ## Configure * Add provider accounts (OpenAI, etc.) * Paste API keys and set default models * Save and test connection ## Model Assignments Model Assignments control which AI models handle different tasks in ProofChat. Scroll to the bottom of the AI Accounts page to view and configure model assignments. ### Required Model Assignments * **Main Chat**: The primary model used for chat conversations and general AI tasks ### Optional Model Assignments You can configure optional model assignments for specific features to optimize performance and cost: #### Optional Model Assignments for AI Script Editor ProofChat's [AI Script Editor](/docs/guides/ai-script-editor) feature uses two optional model purposes that you can configure for better performance and cost efficiency: **FM-Script-Step-Classifier** * **Purpose**: Classifies individual script steps to identify their type and structure during script generation. * **Recommendation**: Use a smaller, faster, and more cost-effective model (e.g., `gpt-4o-mini` or `gpt-3.5-turbo`) since classification is a simpler task that doesn't require the full capabilities of larger models. **FM-Script-Step-XML-Generator** * **Purpose**: Generates FileMaker XML clipboard format from script step text. * **Recommendation**: Use a smaller, faster, and more cost-effective model (e.g., `gpt-4o-mini` or `gpt-3.5-turbo`) since XML generation follows a structured format that smaller models handle well. **Configuration**: Both model purposes are optional. If not configured, ProofChat will automatically use your "Main Chat" model. To configure them: 1. Scroll to **Model Assignments** in Settings → AI Accounts 2. Find **FM-Script-Step-Classifier** and select a smaller model 3. Find **FM-Script-Step-XML-Generator** and select a smaller model 4. Save your changes For complete information about the AI Script Editor feature, see the [AI Script Editor Guide](/docs/guides/ai-script-editor). ## Related * [AI Accounts and Models](/docs/integration/ai-accounts-and-models) - Integration guide for setting up AI accounts * [AI Script Editor](/docs/guides/ai-script-editor) - Generate FileMaker scripts with AI * [/docs/data-privacy](/docs/data-privacy) # Chat Runtime URL: /docs/reference/settings/chat-runtime *** title: Chat Runtime description: Configure which chat backend powers your conversations. -------------------------------------------------------------------- ## Summary * **Purpose**: Choose between FileMaker-backed runtime or Ottomatic AI Runtime for processing chat conversations * **Audience**: Admins, developers * **Prereqs**: [AI Accounts and Models](/docs/integration/ai-accounts-and-models) configured ## Overview ProofChat supports two runtime modes that determine how your AI chat conversations are processed. Each runtime offers different capabilities, features, and trade-offs to suit various use cases and requirements. **Important**: Changing runtime modes will reload the application to ensure a clean transition. Your conversation history is preserved across both modes. ## FileMaker Runtime ### What It Is The FileMaker Runtime uses FileMaker's scripting engine to process AI chat conversations directly within your FileMaker solution. All AI processing happens through FileMaker scripts that call your configured AI provider. ### Key Features * **Local FileMaker script execution**: Chat requests are processed by FileMaker scripts * **Direct database integration**: Messages are stored and retrieved directly from FileMaker tables * **No external server required**: All processing happens within your FileMaker environment * **Full control over message state**: Complete control over how messages are stored and managed ### Best For * Users who need FileMaker-only processing * Deployments where external servers are not desired * Situations requiring full control over message state and storage * Available on all license types (free and Pro) ### Limitations * **AI Provider Support**: OpenAI only * **Streaming**: Standard streaming performance * **Tool Features**: Basic tool result handling (manual submission) * **Advanced Features**: Limited to core chat functionality ## Ottomatic AI Runtime ### What It Is The Ottomatic AI Runtime uses an external server to process AI requests with enhanced features and advanced streaming capabilities. This runtime provides a more flexible architecture that enables additional AI providers and advanced features. ### Key Features * **Server-based AI processing**: Requests are processed by external Ottomatic AI server * **Multiple AI provider support**: Currently supports Anthropic and OpenAI, with more providers coming soon * **Enhanced streaming performance**: Improved real-time response rendering * **Automatic tool result submission**: Tools execute and submit results automatically without manual intervention * **Advanced Ottomatic AI features**: Access to features like [AI Script Editor](/docs/guides/ai-script-editor) * **Flexible foundation**: Designed to support many more AI providers in the future ### Best For * Users who want access to multiple AI providers (Anthropic, OpenAI, and more coming) * Deployments that can use external servers * Users who need advanced features like AI Script Editor * Situations requiring enhanced streaming and automatic tool handling * Available on free license (with rate limits) and Pro ### License Access Ottomatic AI Runtime is available on both free and Pro licenses: * **Free License**: 25 requests per 24-hour period * **ProofChat Pro**: Higher rate limits for production use See [Pricing and Licensing](/docs/guides/pricing-overview) for details. ### Requirements * External server connectivity * Internet access for AI API requests ## Key Differences | Feature | FileMaker Runtime | Ottomatic AI Runtime | | --------------------------- | -------------------------- | ------------------------------------------------ | | **Processing** | FileMaker script execution | External server | | **AI Providers** | OpenAI only | Anthropic, OpenAI (more coming soon) | | **Database Integration** | Direct integration | Storage-only | | **External Server** | Not required | Required | | **Streaming Performance** | Standard | Enhanced | | **Tool Result Handling** | Manual submission | Automatic submission | | **Advanced Features** | Core functionality | AI Script Editor, advanced Ottomatic AI features | | **License Access** | Free and Pro | Free (25 req/24hrs) and Pro (higher limits) | | **Future Provider Support** | Limited | Expanding (more providers coming) | ## Switching Runtimes To change your runtime mode: 1. Navigate to **Settings** → **Chat Runtime** 2. Select your desired runtime: * **FileMaker Runtime** - Click "Active" button (if not already active) * **Ottomatic AI Runtime** - Click "Select" button (if not already active) 3. Confirm the runtime switch 4. The application will reload with the new runtime Switching runtime modes will reload the application to ensure a clean transition. Your conversation history is preserved across both modes - all threads and messages remain accessible regardless of which runtime you're using. ## Which Runtime Should I Use? ### Choose FileMaker Runtime If: * You want all processing to stay within FileMaker * You only need OpenAI as your AI provider * External servers are not an option for your deployment * You need maximum control over message state management ### Choose Ottomatic AI Runtime If: * You want to use Anthropic, OpenAI, or upcoming AI providers * You need advanced features like AI Script Editor * You want enhanced streaming performance * You need automatic tool result submission * You want access to the expanding provider ecosystem ## Related * [AI Accounts and Models](/docs/integration/ai-accounts-and-models) - Configure AI providers and models * [AI Script Editor](/docs/guides/ai-script-editor) - Generate FileMaker scripts with AI (requires Ottomatic AI Runtime) * [Pricing and Licensing](/docs/guides/pricing-overview) - Understanding ProofChat license tiers * [License Management](/docs/guides/license-management) - Managing your ProofChat license # MCP Servers URL: /docs/reference/settings/mcp-servers *** title: MCP Servers description: Configure Model Context Protocol (MCP) servers to extend ProofChat's capabilities. ----------------------------------------------------------------------------------------------- ## Summary * Purpose: Connect to external MCP servers and access their tools * Audience: Developers, admins * **License Requirement**: This is a ProofChat Pro feature with limited access on free licenses. See [Pricing and Licensing](/docs/guides/pricing-overview) for details. ## Requirements and Limitations ### Supported MCP Transport Types ProofChat currently supports **only streaming HTTP** transport for MCP servers. The following transport types are not supported: * **SSE (Server-Sent Events)**: Not currently supported * **STDIO**: Not currently supported When configuring an MCP server, ensure it uses streaming HTTP transport compatible with the Model Context Protocol specification. ### License Access * **ProofChat Pro**: Full access to MCP server configuration * **Free License**: Limited or no access to MCP server features For details on license tiers and upgrading, see the [Pricing and Licensing Guide](/docs/guides/pricing-overview). ## Configure * Add MCP server configurations with URL and authentication headers * Each server provides tools that can be called during chat sessions * Manage multiple server connections from a single interface * **Note**: Only streaming HTTP transport is supported ## Adding an MCP Server 1. Navigate to **Settings** → **MCP Servers** 2. Click **Add Server** 3. Enter a unique **Name** for the server (e.g., "Harvest API") 4. Provide the **URL** for the MCP server endpoint 5. Add any required **Headers** for authentication (e.g., API keys) 6. Click **Create** to save the configuration ## Managing MCP Servers * **Edit**: Update server URL or headers (name cannot be changed after creation) * **Delete**: Remove a server configuration * Server configurations are stored in FileMaker system data ## How It Works Once configured, MCP servers are automatically connected when chat requests are made. The tools provided by each server become available to the AI model during conversations, allowing it to: * Access external APIs and services * Perform actions outside of FileMaker * Extend ProofChat's functionality dynamically ## Related * [/docs/reference/settings/tools](/docs/reference/settings/tools) - Configure tools that display results * [/docs/concepts/tools-are-scripts](/docs/concepts/tools-are-scripts) - Understanding tool execution * [/docs/guides/pricing-overview](/docs/guides/pricing-overview) - Understanding ProofChat license tiers and Pro features * [/docs/guides/license-management](/docs/guides/license-management) - Managing your ProofChat license # Tools URL: /docs/reference/settings/tools *** title: Tools description: Configure tools that ProofChat can call and how results are displayed. ----------------------------------------------------------------------------------- ## Summary * **Purpose**: Reference for using the Settings → Tools interface * **Audience**: Developers, admins * **Prereqs**: [/docs/concepts/tools-are-scripts](/docs/concepts/tools-are-scripts) ## Overview The Tools settings page (`Settings → Tools`) lets you configure which FileMaker scripts are available as tools that the AI can call during conversations. This page is a reference for using the interface—for understanding how tools work and creating them, see [Tools are Scripts](/docs/concepts/tools-are-scripts). ## Tools Configuration Interface The Tools settings page provides a table view of all configured tools with management capabilities. ### Table Features * **Search**: Filter tools by name or script name * **Status Filter**: Show all, enabled only, or disabled only * **Type Filter**: Show all, text output, or component output * **Enable/Disable Toggle**: Quickly enable or disable tools without editing * **Actions Menu**: Edit or delete tool configurations ### Adding a New Tool Click the **"Add Tool"** button to open the configuration modal. The modal has four tabs: 1. **Basic Info**: Core tool identification and settings 2. **Parameters**: Define what data the tool expects 3. **Tool Schema**: Preview the OpenAI-compatible schema sent to the AI 4. **Output**: Configure how results are displayed ## Tool Configuration Modal ### Basic Info Tab Configure the core identification and behavior settings for your tool. #### Tool Name * **Format**: Lowercase with underscores (e.g., `get_weather`, `create_invoice`) * **Purpose**: This becomes the function name the AI uses to call your tool * **Example**: `search_customers`, `update_order_status` #### Description * **Critical**: The AI uses this description to decide when to call your tool * **Best Practices**: * Be specific about what the tool does * Mention when it should be used * Include example use cases * Example: *"Searches for customer records by name, email, or phone number. Use when users ask to find customers or look up contact information."* #### Script Name * **Format**: The exact name of your FileMaker script (case-sensitive) * **Purpose**: Maps the tool to the script that will execute * **Example**: `HandleCustomerSearch`, `ExecuteInvoiceCreation` #### Enabled * **Default**: Enabled (checked) * **Purpose**: Control whether the tool is available to the AI * **Use Case**: Temporarily disable tools without deleting them #### Require Confirmation * **Default**: Disabled (unchecked) * **Purpose**: Show a confirmation dialog before executing the tool * **Use Case**: Enable for destructive operations (delete records, modify critical data) or sensitive actions ### Parameters Tab Define the parameters your tool accepts. Parameters use the OpenAPI schema standard, which the AI uses to understand what data to pass to your script. #### Parameter Types * **String**: Text values * **Number**: Numeric values * **Boolean**: True/false values * **Object**: Nested objects (use dot notation for nested properties) * **Array**: Lists of values #### Dot Notation for Nested Objects Use dot notation to define nested parameter structures: * `contact.first_name` → Creates nested object: `{ contact: { first_name: "..." } }` * `user.profile.email` → Creates deeper nesting: `{ user: { profile: { email: "..." } } }` When the AI calls your tool with nested parameters, they're passed to your FileMaker script as JSON in the script parameter. #### Required Parameters Mark parameters as required only when absolutely necessary. Optional parameters allow the AI more flexibility in tool usage. #### Enum Values For string parameters with limited valid values, define enum options: * **Example**: Status parameter with values: `["active", "inactive", "pending"]` * **Benefit**: Restricts input to valid options and helps the AI understand valid values #### Parameter Best Practices 1. Use descriptive names that clearly indicate purpose 2. Provide clear descriptions for each parameter 3. Use dot notation for logically grouped data 4. Mark parameters required only when essential 5. Use enums for constrained string values 6. Test your tool after configuring parameters ### Tool Schema Tab This tab shows a preview of the OpenAI-compatible schema that will be sent to the AI model. This schema is generated from your Basic Info and Parameters configuration. **What you see**: * The tool name (function name) * Tool description * Parameter schema with types and descriptions **Why it's useful**: * Verify your configuration is correct * See exactly what the AI will receive * Validate parameter structure before saving ### Output Tab Configure how your tool's results are displayed. There are two response types: #### Default (Text Response) * **How it works**: Tool results are sent back to the AI model, which interprets them and crafts a natural language response * **Use when**: * Results need AI interpretation * You want conversational responses * Data doesn't fit predefined component formats * **Example**: A search tool returns raw data, and the AI explains "I found 5 customers matching your criteria..." #### Component Display * **How it works**: Tool results are rendered directly using a predefined display component * **Use when**: * You want structured visualizations (tables, charts, KPIs) * Data format matches available components * You want immediate visual feedback * **Available Components**: See [Tool Components](/docs/reference/tool-components) for complete documentation with expected data formats Available components include: * **Data Table** (`data-table`) - Simple column/row format * **Data Table - DAPI Format** (`data-table-filemaker`) - FileMaker Data API response format * **Data Table - Pipe Separated** (`data-table-psv`) - Pipe-separated values * **Key-Value Display** (`key-value-display`) - Key-value pairs with descriptions * **Markdown Viewer** (`markdown-viewer`) - Formatted markdown content * **FileMaker Record** (`filemaker-record`) - Record info with navigation * **KPI Display** (`kpi-display`) - Key performance indicators with trends * **Data Visualization** (`data-visualization`) - Interactive charts and tables #### Expected Format Display When you select a component, the modal shows the expected data format with a copy button. Copy this format to reference when writing your FileMaker script. For detailed component documentation and expected formats, see [Tool Components](/docs/reference/tool-components). ## Related * [/docs/concepts/tools-are-scripts](/docs/concepts/tools-are-scripts) - Understand how tools work and how to create them * [/docs/reference/tool-components/](/docs/reference/tool-components) - Detailed documentation for each display component * [/docs/reference/settings/mcp-servers](/docs/reference/settings/mcp-servers) - Configure external MCP servers that provide additional tools * [/docs/integration/configuration-scripts/chat-tools](/docs/integration/configuration-scripts/chat-tools) - Advanced: Override tools per file via script # Tool Components URL: /docs/reference/tool-components *** title: Tool Components description: Catalog of components used to render tool results. --------------------------------------------------------------- ## Overview Tool components are predefined display formats that can be used to render tool results directly in the chat interface. When configuring a tool in Settings → Tools, you can choose to use component display instead of the default text response. See [Tools Configuration](/docs/reference/settings/tools) for information on how to configure tools to use these components. ## Response Types ### Default (Text Response) When a tool uses the default text response type: * Tool results are sent back to the AI model * The AI interprets the results and crafts a natural language response * Use when results need AI interpretation or don't fit predefined component formats ### Component Display When a tool uses component display: * Tool results are rendered directly using a predefined display component * No AI interpretation is needed * Use when you want structured visualizations (tables, charts, KPIs) * Your FileMaker script must return data in the exact format expected by the selected component ## Available Components ### Data Table (`data-table`) Simple column/row table format with sortable columns. **Expected Format**: ```json { "columns": ["Name", "Age", "City"], "rows": [ ["John Doe", 30, "New York"], ["Jane Smith", 25, "London"] ] } ``` **Use Case**: Displaying simple tabular data with uniform structure. ### Data Table - DAPI Format (`data-table-filemaker`) Displays FileMaker Data API response format with automatic field extraction and metadata display. **Expected Format**: ```json { "response": { "data": [ { "recordId": "1", "modId": "0", "fieldData": { "Name": "John Doe", "Age": 30 } } ], "dataInfo": { "database": "MyDatabase", "layout": "Contacts", "table": "Contacts", "totalRecordCount": 100, "foundCount": 1, "returnedCount": 1 } }, "messages": [{"code": "0", "message": "OK"}] } ``` **Use Case**: Displaying FileMaker Data API query results directly without transformation. ### Data Table - Pipe Separated (`data-table-psv`) Pipe-separated values format with automatic type detection. **Expected Format**: ```json { "content": "Name|Age|City\nJohn Doe|30|New York\nJane Smith|25|London", "delimiter": "|" } ``` **Use Case**: Displaying data already formatted as pipe-separated values (PSV format). ### Key-Value Display (`key-value-display`) Shows key-value pairs in a clean format with optional descriptions. **Expected Format**: ```json { "items": [ {"key": "Status", "value": "Active"}, {"key": "User Count", "value": 1250}, { "key": "Premium", "value": true, "description": "Premium features enabled" } ] } ``` **Use Case**: Displaying metadata, status information, or configuration data as key-value pairs. ### Markdown Viewer (`markdown-viewer`) Renders formatted markdown content with optional syntax highlighting. **Expected Format**: ```json { "content": "# Analysis Results\n\nThe system processed **500 records** successfully.", "enableSyntaxHighlighting": true } ``` **Use Case**: Displaying formatted reports, documentation, or analysis results with rich text formatting. ### FileMaker Record (`filemaker-record`) Displays record information with a navigation button to open the record in FileMaker. **Expected Format**: ```json { "tableName": "Contacts", "recordId": "123", "message": "Contact John Doe has been successfully updated." } ``` **Use Case**: Displaying confirmation messages after record operations with direct navigation to the record. ### KPI Display (`kpi-display`) Shows key performance indicators with trends, progress bars, and comparison data. **Expected Format**: ```json { "items": [ { "label": "Total Sales", "value": 125000, "format": "currency", "previousValue": 110000, "change": 13.6, "changeType": "percentage", "trend": "up", "unit": "$", "description": "Monthly sales revenue" } ], "layout": "grid", "columns": "auto" } ``` **Use Case**: Displaying business metrics, performance indicators, or dashboard-style data with trends and comparisons. **Additional Features**: * Progress bars and rings * Sparkline charts * Multiple layout options (grid, list, compact) * Configurable sizing (sm, md, lg, xl) ### Data Visualization (`data-visualization`) Interactive data visualization with multiple view options (table, bar chart, line chart, list). **Expected Format**: ```json { "args": { "usersQuestion": "Show me all customers from California", "displayFormat": "table" }, "result": { "data": "Name|City|State|Total Orders\r\nAcme Corp|San Francisco|CA|42", "displayFormat": "table", "tableName": "Customers", "sql": "SELECT Name, City, State FROM Customers WHERE State = 'CA'", "complete": true, "chartConfig": { "xKey": "Name", "yKey": "Total Orders" } } } ``` **Use Case**: Displaying query results with interactive charting capabilities. Users can switch between table, bar chart, line chart, and list views. **Additional Features**: * Multiple chart types (bar, line, table, list) * Interactive switching between views * Export to CSV * SQL query display * FileMaker record navigation ## Using Components in Tool Configuration When configuring a tool in Settings → Tools: 1. In the **Output** tab, select **"Component Display"** instead of "Default (Text Response)" 2. Choose the appropriate component from the dropdown 3. The modal will display the expected data format with a copy button 4. Copy the format and ensure your FileMaker script returns data in that exact structure 5. Save the tool configuration For detailed instructions on configuring tools, see [Tools Configuration](/docs/reference/settings/tools). ## Legacy Components The following components are documented separately but may be superseded by newer runtime components: * [KPI Card](/docs/reference/tool-components/kpi-card) - Legacy KPI component * [Table](/docs/reference/tool-components/table) - Legacy table component ## Related * [Tools Configuration](/docs/reference/settings/tools) - How to configure tools to use these components * [Tools are Scripts](/docs/concepts/tools-are-scripts) - Understanding how tools work # KPI Card URL: /docs/reference/tool-components/kpi-card *** title: KPI Card description: Present a key metric with optional context. -------------------------------------------------------- ## Usage * Provide label, value, optional delta * Keep labels concise; prefer short units ## Example ```json { "type": "kpi-card", "label": "Open Tickets", "value": 12, "delta": -3 } ``` # Table URL: /docs/reference/tool-components/table *** title: Table description: Render tabular data returned by a tool. ---------------------------------------------------- ## Usage * Provide columns and rows * Limit columns to what’s relevant; avoid sensitive fields ## Example ```json { "type": "table", "columns": ["ID", "Name", "Status"], "rows": [[1, "Acme", "Active"]] } ```