Read-Me for File Reference Fixer™
What can MetadataMagic's File Reference Fixer do?
Using the advanced technology of MetadataMagic, File Reference Fixer can locate and change file references (and the items that use them) within your FileMaker Pro database files. This is an efficient alternative to the old labour intensive method of changing items that use file references one at a time.
File Reference Fixer (FRF) provides 5 functions:
- Auto-Fix
- Consolidate
- Set Relative-Only
- Set Network Address
- Remove Unreferenced
"Auto-Fix" is an easy way to fix file references for those straight-forward solutions that are always contained in one folder, or hosted from one server. For best results, more complex solution structures should be handled using the individual functions.
"Consolidate" adjusts script steps, relationships and value lists to use a single consistent file reference to locate an external file. This makes it possible to remove subtle problems caused when different file references attempt to locate the same file in different ways. Consolidate also provides a straight-forward way to update references to files when changing network/server configurations (Click "Special Situations" on the FRF menu for details).
"Set Relative-Only" provides a means to update file references to the "Save relative path only" option. For straight-forward solutions where all of the files are hosted from one server, or all in one local folder, this is the best way to avoid problems. Non-relative-only file references were created in FileMaker Pro 5.0 and earlier, and can still be created, either intentionally or inadvertently.
"Set Network Address" provides a means to update or set a specific network address. When clients must access a server in another subnet, the local subnet address (*) or an old network address can cause missing file problems.
"Remove Unreferenced" provides a means to remove the filename and path information for file references that are no longer used. Unlike the other FRF functions, Remove Unreferenced operates on all file types referenced, not just those that point to other FileMaker Pro database files in the solution.
What does File Reference Fixer not do?
File Reference Fixer (FRF) does not change FileMaker Pro filenames. To do this, use the FileMaker Developer Edition.
FRF cannot remove the "Save relative path only" flag, which requires creating path information specific to FileMaker. Click "Special Situations" on the FRF menu for a recommended work-around if you want to switch a file reference to non-relative-only.
Except for the Remove Unreferenced function, FRF does not operate on file references for non FileMaker Pro files (eg. some formats of import/export files, send message, etc.) MetadataMagic will show you where such file references are used, so they can be re-pointed manually.
About File References
What is a file reference?
A file reference is stored by FileMaker Pro when the developer specifies an external file from the Import Records, Open, Close, or Recover script steps. A value list specifying an external file or a relationship (other than a self-relationship) also generates a file reference.
Items that use file references refer to them by their file reference ID number. File references are invisible in the normal user interface of FileMaker Pro, but can be viewed in MetadataMagic.
When do file references need fixing?
The development environment is usually very different from the user environment. As a result, file references specified in the development environment rarely match the deployment environment beyond the file name.
Due to FileMaker Pro's flexibility and ingenuity in locating files, partially incorrect file references often continue to work for a long time without obvious problems. As a result, problems typically appear only after deployment (when they become harder to fix!).
When file references are incorrect, a variety of problems can result, ranging from a decrease in performance to the user being presented with a usually baffling "This file could not be found, please locate it..." dialog.
The severity of the problems depends on the extent that the file references are incorrect.
To prevent problems, file references should be reviewed (and fixed, if necessary) after development and before testing and deployment.
Fixing file references can also resolve some problems with legacy solutions.
How do file references become incorrect?
- FileMaker Pro 5.0 and earlier did not have the "Save relative path only" checkbox; legacy files developed using one of these versions contain paths to files that are usually out of date, and may be problematic.
- When an enterprise network is reconfigured, network addresses change. Hosted files that used to be located in the current subnet may not be easily found if moved to another subnet.
- When needs change, hosting configurations can change. Different files of the same solution may be split across multiple servers for improved performance. A stand-alone solution may become multi-user. A complex solution may be designed to have some local files on each client's computer, along with some hosted multi-user files.
- During development, it is not uncommon to have multiple copies of solution files on the development computer; when selecting a file, it is easy to select the wrong copy by mistake, no warning is given, and operation may appear to continue properly.
MetadataMagic and File Reference Fixer are products of:
New Millennium Communications, Inc.
1332 Pearl Street
Boulder, Colorado
80302 USA
In association with:
Sigma Seven Systems Ltd.
Box 98
Mill Bay BC V0R 2P0
Canada
MetadataMagic web page
www.newmillennium.com
MetadataMagic email contact
plug-ins@nmci.com
Copyright and Trademark Notices
MetadataMagic is ©2004 Sigma Seven Systems Ltd. All rights reserved.
©2004, Sigma Seven Systems Ltd. All rights reserved.
MetadataMagic and MetadataMagic_PI are trademarks of New Millennium Communications, Inc.
FileMaker and ScriptMaker are trademarks of FileMaker, Inc.
Macintosh, MacOS, and AppleScript are trademarks of Apple Computer, Inc.
Windows is a trademark of Microsoft Corp.
Other trademarks are of their respective owners.