FM BetterForms
BF Editorfmbetterforms.com
master
master
  • Introduction
  • 🏆Features
  • Getting Started
    • Welcome to FM BetterForms!
    • System Overview
    • Quick Tour of the BetterForms IDE
    • Phase 1: Setting Up Your Foundation
      • 1.1 Configure FileMaker Server
      • 1.2 Install BetterForms Helper File
      • 1.3 Add Your Server to BetterForms (IDE)
    • Phase 2: Building Your First Application
      • 2.1 Create an App (Site) in the IDE
      • 2.2 Create Your First Page (Intro to Page Builder)
      • 2.3 Understanding & Managing Environments (IDE)
      • 2.4 Adding Elements to Your Page
      • 2.5 Understanding Validation
      • 2.6 Adding Actions to Your Page
      • 2.7 Creating Your First List View
      • 2.8 Understanding Page Data Flow
      • 2.9 Creating Your First Hook
      • 2.10 Working with Data Tables (Coming Soon)
    • Phase 3: Understanding Core BetterForms Concepts
      • 3.1 Introduction to Hooks (and where to find them in the IDE)
      • 3.2 Running Your First Hook (Practical Example)
      • 3.3 Introduction to Actions & Action Scripts (IDE Context)
      • 3.4 Understanding the Data Model (and Page Data Model UI)
    • Phase 4: Common Customizations & Expanding Your App
      • 4.1 Adding & Configuring Buttons (Page Builder)
      • 4.2 Implementing Page Navigation (Actions & Site Navigation UI)
      • 4.3 Displaying Data in Tables (Page Builder & Element Config)
      • 4.4 Basic App Styling (Site Styling UI)
    • Phase 5: Mastering the BetterForms Environment & Advancing Your Skills
      • 5.1 Understanding & Managing Environments (In-Depth)
      • 5.2 Deep Dive: Page Configuration & Settings
        • Navigating the Page Builder Interface
        • Working with Page-Level Action Scripts
        • Configuring the Page Data Model
        • Page Integration Settings Explained
        • Managing Page Info & Other Settings
      • 5.3 Working with Global Scripts
      • 5.4 Managing App (Site) Settings & Navigation
      • 5.5 Exploring Further: What to Learn Next
    • Support & Resources
      • Getting Help
      • Learning JSON
  • Reference
    • Site Settings
      • Navigation
      • App Model
      • DOM Header Insertions
      • Global Named Actions
      • Site Structure
      • Slots / Code Injection
    • Page Settings
      • Data Model
      • Card / Window Modals
      • Validation
        • Custom Validators
      • Misc Page Settings
    • Page Elements
      • Copy of Site Structure
      • BetterForms Elements
        • Checkbox
        • Checklist
        • Cleave.js Input Masking
        • DateTime Picker
        • Google Address Autocomplete
        • Image Display Element
        • Input
        • Masked Input
        • Range Slider (noUiSlider)
        • Radios
        • Select
        • Advanced Select (selectEx)
        • TextArea
      • Common
        • Input
        • Button
        • Data Table
        • HTML
      • Grouping Elements
        • Tabs
        • Panel
        • accordion
        • accordion2
        • listrows
      • Uploading Files
        • dropzone
        • dropzone to S3
        • uploadCare
        • 🏗️Uppy File Upload Widget Integration with AWS S3
      • Misc Elements
        • Plain Text / Code Editor
        • signature
        • fullCalendar
        • rangeSlider
      • Payment Gateways
        • Authorize.net
        • PayPal
        • Stripe
      • Adding Custom Page Elements
    • Actions Processor
      • Named Actions (Action Scripts)
      • Actions
        • runUtilityHook
        • path
        • debounce
        • throttle
        • showAlert
        • showModal / hideModal
        • function
        • clipboard
        • cookie
        • setFocus
        • scrollTo
        • wait
        • emit
        • validate
        • channelJoinAnon
        • channelLeaveAnon
        • messageSend
        • messageSendAnonChannel
        • consoleError
        • showStripeCheckout
      • Authentication Actions
    • Script Hooks
      • Globals Variables
        • $$BF_Model
        • $$BF_App
        • $$BF_State
      • Keeping Keys Private
      • Reducing Payload Size
      • API Callback Endpoint
      • Common Hooks
      • Scoped Hooks
    • Users & Authentication
      • Managing User Accounts
      • Custom Login Pages
      • OAuth
    • Advanced Configuration
      • Custom Domains
    • BF Utility Functions
      • Example Usage
        • BF.i18n()
    • BF Error Codes
    • Messaging
      • Adding users to channels
      • Removing users from channels
      • Sending messages
      • Get connected users
      • Get active channels
    • Practices for File Downloads
    • BF Streaming Proxy
    • Updating the Helper File
    • Connection Trouble Shooting Guide
    • Software Testing Overview
    • JavaScript Libraries
    • FM BetterForms - Quality Assurance
    • Rollbacks and Version Control
    • BF Server Proxy
    • Setting up Auth0
    • Create an S3 Bucket on AWS
    • ApexCharts - Getting started
    • BF Enterprise Documentation
    • BetterForms Error Pages API
    • BF Streaming API
    • Creating a PWA
  • Usage Tips
    • Troubleshooting
      • Debugging
      • Frozen Actions Queue
      • Vue Variables
    • JavaScript Tips
      • Calling Named Actions from HTML Vue Events
      • Calculations
    • Hacking a Webpage
    • System Overview
    • Forms Processor
      • Form Types
      • HTML & VueJS
      • Styling and Design
    • Customizing and Styling
      • Custom CSS
      • Custom Components
        • Components Editor
        • Component Best Practices
      • Page Pre-loaders
      • Favicon
    • Design Patterns and Best Practices
      • Working with environments
      • Handling Data
      • Saving Data
      • Data Optimization
      • Business Logic
      • UI / UX
      • Debugging
      • Script Engine Optimization
    • Getting Started
    • Installation
  • Security
    • Authentication
    • Security White Paper
    • Firewalls
    • Technology Stack
  • Compatibility
Powered by GitBook
On this page

Was this helpful?

  1. Reference

Updating the Helper File

PreviousBF Streaming ProxyNextConnection Trouble Shooting Guide

Last updated 6 months ago

Was this helpful?

Guide to Migrate the Helper File

Below are the steps for migration and configuration of the helper file. Additionally, we recommend familiarizing yourself with the general documentation, which provides answers to many questions.

  1. Download the Helper File using .

  1. Open the Helper File:

Make sure you have the FileMaker installed and open file use below credentials:

User name : admin

Password : admin

A window will appear, prompting you to set a new password.

  1. Change default user and password:

Change the default user and password (admin / admin) to your desired credentials. This password is for file access purposes only and applies solely to this file.

  1. Set Up Your Own Account:

  • Go to File > Manage > Security

  • Click "+New" to create a new account.

  • Type the Account Name, set a Password, and select a Privilege Set.

  • Click OK to save the new account.

  1. Import User Records (If Needed):

  • Open FileMaker Pro.

  • Open the app where you want to import the existing user records.

  • Go to "File" in the menu and select "Import Records."

  • Choose the file format of the existing user records (e.g., Excel, CSV, FileMaker Pro file).

  • Select the file containing the existing user records and click "Open."

NOTE! ( if your old helper file is located on the server, you can specify the path by clicking the "hosts" button when selecting the file. )

  • Map the fields in the import file to the corresponding fields in the app.

Also, make sure that the auto-enter function is turned off.

  • Configure any additional import options as needed.

  • Preview the import to verify the mappings and data.

  • Click the "Import" button to import the existing user records.

At the end, an "Import Summary" window with the results should appear.

  1. Configure Helper File:

  • Ensure the file is hosted on the server.

  • Go to File > Manage > External Data Sources.

  • Click "New" in the "Manage External Data Sources" dialog box.

  • Click "Add File" in the "Edit Data Source" dialog box.

  • Locate and select the new Helper File (click "hosts" if the file is on the server).

  • Choose the FileMaker application and click OK > OK > OK.

  1. Configure Hooks in Script Workspace:

  • Go to Script > Script Workspace.

  • Set up Hooks - “Developer - Transmitter - CONFIGURE HERE”.

  • Type or copy the required items from the previous file and paste them.

  • Click on "Betterforms - App - Receiver and Dispatch" to see them on the Specify Script window.

We can see them on the Specify Script window.

We need to replicate the steps we made in the helper file in the FileMaker application.

  1. Sync App with Frontend:

(If the file is replaced with the same name, there is no change needed in the BF editor. If not, make sure you use the same credentials.)

  • Open the environments list and choose the environment.

  • Click the three dots menu > Edit.

Go to Credentials, select the server, and set up HelperFile Name, Account Name, and Password.

(They should be the same as in your helper file)

  1. Test Connection:

  • Test the connection from frontend to the business file by hitting the API endpoint (e.g., yourapp.com/api).

  • Verify if the connection is successful and the records appeared.

  1. Test the functionality of your apps.

https://docs.fmbetterforms.com/getting-started/integration
this link