RESTfmSync Installation and Configuration Manual

Copyright © Goya Pty Ltd 2011-2018. All rights reserved.

Requirements

You must have a working copy of RESTfm installed and running. You can check your RESTfm installation using the built in report page found at RESTfm/report.php

Then check that your FileMaker file is available and accessible in the RESTfm detail pages.

RESTfmSync requires FileMaker 13 or later.

Security Considerations

Each FileMaker file hosted on FileMaker Server needs to have one or more accounts that you access via RESTfm.  These accounts need to have a privilege set that allows modification to records and access to the layouts you are going to use for RESTfm.  The account used doesn't need to be tied to the individual using the local file, as they need a higher privilege set to allow them to overwrite other users records when making updates.

Exactly how you structure your account and privileges is up to the developer, and you should consider all of the security and authentication options available in RESTfm.

Overview

You have a FileMaker database, hosted on FileMaker Server.  Separately you have a file you're modifying locally in Pro that is going to be your "sync" file.  It will connect to the FileMaker Server box via RESTfmSync for this operation.  Once the modifications are complete you can distribute this file on Pro or Go for end users to utilise.

Although it's possible for the server and local files to be the same file, all of the documentation will assume that they're separate, and will refer to the "Server File" and the "Local File" separately.  The setup described in this documentation assumes that all changes to the data are done on the Local File while the Server File is just a set of passive tables used as a central repository.

Documenting as you go along

It's worth while documenting the list of tables in the solution as some changes need to be done once for each table.  Keep a list of them all and cross off the table list when you've completed each one.

Contents